Error Codes

HTTP Status Codes

The Management API returns standard HTTP status codes in response to an API call.

HTTP Status Code Description
2xx Successful responses
4xx Client errors
5xx Server errors


Error Codes

When an error is detected with an API request, a standard response format is returned. The errors object returns a list of one or more identified errors detected within the API request.

{
    "errors": [{
        "code": "error_code",
        "description": "Something went wrong."
    }, {
        "code": "error_code",
        "description": "Something else went wrong."
    }]
}
Property Description
code string Standardized error label

This label can be used by software to make determinations about how to respond to the error.
description string Human-readable explanation of the error

The following sections list the code and description returned for each possible error, organized by HTTP status code.


4xx

Status Code Code Description
400 (varies) An invalid JSON request body or payload has been provided as part of the API call

See: 400 Specific Errors
401 unauthorized Provided authentication credentials are invalid
403 forbidden Requestor does not have permission to perform the request
404 not_found requested resource could not be found
405 method_not_allowed Provided method is not allowed on the targeted resource
409 conflict Request conflicts with state of target resource
422 unprocessable Provided request cannot be processed
429 rate_limit_exceeded Rate limit has been exceeded

The Management API rate limit is 60 requests/minute per API secret. Calls that exceed this rate will not be executed.

If your implementation exceeds this rate limit, contact our Support team. Our Support team can evaluate your implementation and provide options to address your requirements.

400 Specific Errors

The table lists all the error codes and description structures for 400 HTTP code responses. These errors provide feedback about how to correct the invalid JSON request body or payload. When multiple issues are present in the JSON request body or payload, the error response will include multiple error codes and descriptions.

📘

The information in the Description column in the following table provides the general structure of the error response description. The details of the error response description are specific to each API route.

Error Code Description
empty Field x cannot be empty.
invalid_format Field x cannot ...y.... Value of z was provided.
invalid_type Field x must be of type y. Value of z was provided.
not_allowed Field x cannot be used with y. Value of z was provided.
required Field x is required.
resource_exhausted You cannot x any more of y. Value of z was provided.
too_high Field x must be lower than y. Value of z was provided.
too_long Field x must be shorter than y characters. Value of z was provided.
too_low Field x must be higher than y. Value of z was provided.
too_short Field x must be longer than y. Value of z was provided.

5xx

Status Code Code Description
500 internal_server_error Unexpected internal server error occurred
502 bad_gateway Dependent service returned an invalid response
503 service_unavailable Dependent service is temporarily unavailable
504 gateway_timeout Dependent service timed out