Server-side errors (5XX)

In case of a server-side error in our system, our API will return an error with an HTTP status code in the 500 to 599 range.

None of these errors can be resolved client side. Please contact support to raise any 5XX errors.

Example

{
    "type": "error",
    "code": "server_error",
    "status": 500,
    "message": "Request could not be processed",
    "details": []
}

Fields

type

string, required

The type of object returned. This is always error.

code

string, required

The machine-readable code for this error. This is one of the following values.

• server_error
• bad_gateway
• gateway_timeout

status

number, required

The HTTP status code of the error. This can be 500, 502, or 504.

message

string, required

The human-readable description of this error.

details

array

A list of validation errors for the request. This is always an empty array for a server error.