Erros

A API usa os códigos HTTP de sempre. Trate os erros pelo código; a mensagem serve para ler nos logs e pode mudar de texto.

Códigos

Formato do corpo

Todo erro devolve um objeto com message, em português:

{ "message": "Recurso não encontrado." }

Quando a causa não tem uma mensagem própria, a API usa a mensagem padrão do código:

Validação

Erros de validação (422) trazem a lista de problemas por campo. A chave é o caminho do campo, com pontos para objetos e números para posições em listas:

{  "message": "O campo content.title é obrigatório. (e mais 1 erro)",  "errors": {    "content.title": ["O campo content.title é obrigatório."],    "variants": ["O campo variants deve ter pelo menos 2 itens."]  }}

Em segmentos, o caminho aponta a regra exata: definition.groups.0.rules.1.op.

Inscrição

A rota de inscrição usa o mesmo formato. Os erros de regra de negócio dela são estes:

O 402 só vale para dispositivos novos. A reinscrição de um navegador que já é assinante continua sendo aceita com a conta no limite, e tags, atributos e login seguem atualizando.

O que fazer em cada caso

Para repetir POST /v1/campaigns depois de um erro de rede sem risco de criar a campanha duas vezes, mande o cabeçalho Idempotency-Key. Veja evitando campanha duplicada.

Idempotência