Error Codes

HTTP Status Codes

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

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."
    }]
}

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

4xx

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.

5xx