O que cada status HTTP quer dizer nesta API e o formato das respostas de erro.
| Status | Significado |
|---|---|
200 | Sucesso. |
201 | Recurso criado. |
202 | Pedido aceito para processamento em segundo plano. |
204 | Sucesso, sem corpo. |
400 | Um campo está ausente ou inválido, ou o corpo não é um JSON válido. |
401 | Credencial ausente, inválida, expirada ou encerrada. |
402 | Saldo insuficiente ou plano sem o recurso. |
403 | Sem permissão no workspace, ou fora do departamento. |
404 | O recurso não existe neste workspace. |
409 | Conflito com o estado atual do recurso. |
413 | O corpo passa do tamanho permitido. |
422 | O pedido está bem formado, mas o conteúdo não pode ser aceito. |
428 | Falta o cabeçalho If-Match com a versão do recurso. |
429 | Limite de requisições atingido. |
500 | Erro inesperado. |
502 | Um serviço externo recusou ou falhou. |
503 | Um 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.