Cadastrar um Consumer

POST

/v1/consumers

Cadastra quem vai receber Eventos, normalmente um cliente seu.

O externalId é o id desse cliente no seu sistema, e é por ele, não pelo id, que você o referencia ao publicar eventos e ao cadastrar endpoints. É único no ambiente.

Autorização

• Bearer

Corpo da requisição^obrigatório

Tipo de mídiaapplication/json

object

externalId

obrigatório

null | string

name

obrigatório

null | string

Exemplo

{
  "externalId": "cliente-42",
  "name": "Padaria do Zé"
}

Respostas

201

Criado.

Tipo de mídiaapplication/json

object

id

obrigatório

string

externalId

obrigatório

string

name

obrigatório

string

createdAt

obrigatório

string formato: date-time

Exemplo

{
  "id": "csm_01JB8XZQ4T9M2NKPWV3RYCF7HD",
  "externalId": "cliente-42",
  "name": "Padaria do Zé",
  "createdAt": "2026-09-10T12:00:00Z"
}

401

Chave de API ausente, inválida ou revogada.

409

Já existe um Consumer com este externalId no ambiente.

Tipo de mídiaapplication/problem+json

object

type

null | string

title

null | string

status

null | integer | string formato: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Exemplo^gerado

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

422

externalId ou name ausente, ou com mais de 200 caracteres.

Tipo de mídiaapplication/problem+json

object

type

null | string

title

null | string

status

null | integer | string formato: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Exemplo^gerado

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Limite de requisições por segundo do plano, somado entre todas as chaves da organização.

Headers

Retry-After

integer

Segundos até a próxima janela.