Error Messsages

Understand API error responses and how to handle them.

When an API request fails, the response includes a status code, a human-readable message, and sometimes an additional error code. All errors are returned as JSON:

Example Error Response

JSON

{
  "status": STATUS,
  "message": "error message",
  "code" : 99
}

Response Fields

• status - In most cases it is a HTTP status but sometimes it can be some other specific error code
• message - detailed or more human readable explanation
• code - In some cases, an additional attribute is provided. It is specific to the situation and may give additional context of why the error occurred.

Common Error Status

• 401 Unauthorized - This error indicates invalid authentication. Validate your information in the application's Integrations / API Keys.
• 441 Activity limit reached - This error indicates API endpoint limits, this is based on many factors but in most cases restricted by CID, i.e. it is account wide limit. The request can be retried.
• 429 Too Many Requests - This error occurs due to exceeding the request limit. The server allows new requests after a short period. This is usually IP based rate limiting. The request can be retried.