Erros

Erros

Toda resposta de erro tem o mesmo corpo:

{
  "error": "Parâmetro desconhecido: stauts.",
  "code": "invalid_parameter"
}
  • code é estável. Compare por ele no seu código.
  • error é uma frase em português para quem lê o log. Ela pode melhorar com o tempo.
  • No 429, o corpo traz também retryAfter, em segundos.

Toda resposta, de sucesso ou de erro, leva o cabeçalho X-Request-Id. Ao falar com o suporte sobre uma falha, informe esse valor.

Códigos

StatuscodeQuando
400invalid_jsonO corpo da requisição não é um JSON válido.
400invalid_parameterParâmetro inválido.
401unauthenticatedNão autenticado.
401invalid_credentialCredencial inválida.
403insufficient_scopeEscopo insuficiente.
404not_foundRecurso não encontrado.
409conflictO estado atual do recurso não permite esta operação.
429rate_limitedLimite de requisições atingido. Tente de novo depois do tempo indicado em Retry-After.
500internal_errorErro interno. Tente de novo; se persistir, fale com o suporte informando o X-Request-Id.

Parâmetros

Parâmetro que a operação não conhece é recusado com 400, para um erro de digitação como stauts=open não devolver a lista inteira sem aviso. Valor fora da faixa também é 400, e a frase diz qual parâmetro.

Identificador que não existe na sua organização é 404, mesmo quando o recurso existe em outra.