Erros

A API usa códigos HTTP para indicar o resultado de cada requisição. Na maioria dos erros, a resposta inclui type e message.

{
  "error": {
    "type": "insufficient_scope",
    "message": "This API key is missing the required scope."
  }
}

Use type para tratar o erro no código. A message é apenas uma descrição e pode mudar.

Tipos de erro

HTTP	type	Quando acontece
401	`unauthenticated`	Chave ausente, inválida ou revogada
403	`insufficient_scope`	A chave não tem o escopo do endpoint
404	`not_found`	O recurso não existe ou pertence a outra conta
422	`idempotency_key_required`	Requisição sem o header obrigatório `Idempotency-Key`
409	`idempotency_in_progress`	Já há uma requisição com essa `Idempotency-Key` em andamento
409	`idempotency_key_reuse`	A `Idempotency-Key` foi reutilizada com outro corpo

Quando os dados enviados são inválidos, a API retorna 422 com os campos que precisam ser corrigidos.

{
  "message": "The name field is required.",
  "errors": {
    "name": ["The name field is required."]
  }
}

Em erros 5xx, uma operação pode não ter sido concluída. Se a requisição altera dados, repita a chamada com a mesma Idempotency-Key.