Códigos HTTP

O que cada status HTTP quer dizer nesta API e o formato das respostas de erro.

StatusSignificado
200Sucesso.
201Recurso criado.
202Pedido aceito para processamento em segundo plano.
204Sucesso, sem corpo.
400Um campo está ausente ou inválido, ou o corpo não é um JSON válido.
401Credencial ausente, inválida, expirada ou encerrada.
402Saldo insuficiente ou plano sem o recurso.
403Sem permissão no workspace, ou fora do departamento.
404O recurso não existe neste workspace.
409Conflito com o estado atual do recurso.
413O corpo passa do tamanho permitido.
422O pedido está bem formado, mas o conteúdo não pode ser aceito.
428Falta o cabeçalho If-Match com a versão do recurso.
429Limite de requisições atingido.
500Erro inesperado.
502Um serviço externo recusou ou falhou.
503Um serviço necessário está indisponível naquele momento.

As respostas de erro trazem um corpo JSON:

{
  "error": true,
  "code": "read_permission_required",
  "message": "Insufficient permissions: requires leads:read in this workspace",
  "expected": {
    "required_permission": "leads:read"
  }
}

Decida o que fazer pelo status e pelo code, que é estável; a message é para pessoas e pode mudar. Os códigos de cada rota estão na descrição dela. O formato completo, as exceções e como tratar cada status estão no guia Erros.