Error Responses

Response Body

When returning an error, the response body contains details of the error represented as a JSON hash.

For example, requesting the invalid “/bad_url” results in:

% curl
"type": "Error",
"message": "Probably a typo (or junk) in your request: /api/bad_url",
"error": "BadRequest"
Status: 400

Hash Keys

The hash keys in an error response include:

the literal string “Error”
specific kind of error, e.g. “NotFound” or “BadRequest”
descriptive or explanatory message
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request