Pular para o conteúdo principal

Mapeamento de erros

Utilizamos códigos de resposta HTTP padrão para indicar sucesso ou falha nas requisições, e nossos erros são classificados adicionalmente por tipo.

MISSING_BODY

  • Status: 400
  • Message: Corpo da requisição é obrigatório.
  • Suggested action: Certifique-se de que o corpo da requisição não esteja vazio.

FORBIDDEN

  • Status: 403
  • Message: O usuário não está autorizado a acessar este recurso devido a uma negação explícita em uma política baseada em identidade.
  • Suggested action: Verifique se a API key está correta ou gere uma nova API key.

CONTACT_NOT_FOUND

  • Status: 404
  • Message: Contato não encontrado.
  • Suggested action: Verifique se o contato existe antes de utilizá-lo.

SEGMENTATION_LIST_NOT_FOUND

  • Status: 404
  • Message: Segmentação não encontrada.
  • Suggested action: Verifique se a segmentação existe antes de utilizá-la.

DEAL_NOT_FOUND

  • Status: 404
  • Message: Oportunidade não encontrada.
  • Suggested action: Verifique se a oportunidade existe antes de utilizá-la.

PIPELINE_NOT_FOUND

  • Status: 404
  • Message: Pipeline não encontrado.
  • Suggested action: Verifique se o pipeline existe antes de utilizá-lo.

STAGE_NOT_FOUND

  • Status: 404
  • Message: Etapa não encontrada.
  • Suggested action: Verifique se a etapa existe antes de utilizá-la.

CONTACT_ALREADY_EXISTS

  • Status: 409
  • Message: O contato já existe.
  • Suggested action: Verifique se o contato já existe antes de criar um novo.

CONTACT_ASSOCIATED_WITH_A_DEAL

  • Status: 409
  • Message: O contato já está associado à uma oportunidade.
  • Suggested action: Verifique se o contato já está associado a uma oportunidade antes de criar ou atualizar.

INVALID_INPUT

  • Status: 422
  • Message: Corpo JSON inválido.
  • Suggested action: Certifique-se de que o corpo da requisição seja válido e que todos os campos obrigatórios estejam presentes.

INVALID_PARAMS

  • Status: 422
  • Messages:
    • DEAL_ID_IS_NECESSARY
    • CONTACT_EMAIL_IS_NECESSARY
    • EMAIL_IS_NECESSARY
  • Suggested action: Certifique-se de que o ID da oportunidade, o email do contato ou o email estejam presentes na requisição.

TOO_MANY_REQUESTS

  • Status: 429
  • Message: Muitas requisições.
  • Suggested action: Para evitar esse erro, recomendamos reduzir a taxa de requisições à API. Isso pode ser feito utilizando um mecanismo de fila ou diminuindo o número de requisições concorrentes por segundo. Caso tenha necessidades específicas, entre em contato com nosso time de suporte.

INTERNAL_SERVER_ERROR

  • Status: 500
  • Message: Ocorreu um erro inesperado.
  • Suggested action: Tente realizar a requisição novamente mais tarde. Caso o erro persista, entre em contato com nosso time de suporte.