Pular para o conteúdo principal

Códigos de erro

A API segue convenções HTTP padrão. Esta página lista os status codes que você pode encontrar e como tratá-los.

Status codes

StatusSignificadoQuando acontece
200 OKSucessoRequisição processada e respondida com sucesso
400 Bad RequestBody / query inválidosCampo obrigatório ausente, tipo de dado incorreto, formato fora do esperado
401 UnauthorizedFalha de autenticaçãoCredencial ausente, inválida, expirada, ou assinatura HMAC incorreta
403 ForbiddenFalta de permissãoCredencial válida, mas sem acesso ao app CRM ou à permissão ADMIN
404 Not FoundRecurso não encontradoevent key desconhecida, ou rota inexistente
500 Internal Server ErrorErro internoFalha inesperada no servidor — pode tentar novamente

Formato do corpo de erro

Erros seguem o formato padrão do NestJS:

{
"statusCode": 401,
"message": "Unauthorized",
"error": "Unauthorized"
}

Para erros de validação (400), o campo message é um array com os problemas encontrados:

{
"statusCode": 400,
"message": [
"anonymousId should not be empty",
"key must be a valid enum value"
],
"error": "Bad Request"
}

Como tratar

ErroAção recomendada
400Corrigir o payload antes de retentar. Não retente em loop — o erro é determinístico.
401Verificar credencial. Para JWT, renovar o token. Para API Key, recalcular a assinatura.
403Verificar permissões da chave/usuário no painel CRM.
404 (event key)Conferir a lista de eventos suportados.
500Implementar retry com backoff exponencial (máx. 3 tentativas). Se persistir, contatar suporte.

Idempotência

Os endpoints de ingestão (/track, /customer-events, /identify) não são idempotentes — duas chamadas idênticas registram dois eventos. Se você precisar de idempotência, use o campo dispatchId para correlacionar e deduplicar no seu lado.