Errors or bad requests caught by the API will always return an appropriate HTTP status code in the response headers (as described in the section), as well as a body containing details about the error occurred:
success
(bool) - Either true
or false
. In the event of an error, this will be false
.
message
(string) - A description of the actual problem encountered
In the event of a user input validation failure, the following will be included in the response body:
validation_errors
(object) - A list of fields and the validation error message
Example error response body: