API Response Errors

HTTP status codes do not always provide sufficient information about the cause of an error. For more detailed programmatic handling of errors, responses contain additional JSON fields that describe the error.

Error format

Whenever an API request results in an error, the response will contain both a high-level error class specified by the code and a human-readable summary in the message.

{"code":2,"message":"Request body contains unprocessable entity."}

Extended error format

In some cases there is extended information available for clients about why a request has failed. For example, failing to supply a value for a required field1 will result in the following error:

{"code":2,"message":"Invalid entity.
metadata.email may not be empty (was null)","errors":[{"error":"invalid_value","location":"metadata.email","message":"metadata.email may not be empty (was null)"}]}

List of API Error Codes

The table below shows the list of error codes that may be returned in an API error response.