When an API call causes an error, you will receive a standardised JSON response as shown in the example below:
{ "request": { "url": "\/3.0\/endpointname", "endpoint": "endpointname", "requested_version": "3.0", "api_version": 3, "request_method": "Post", "timestamp": 1507620684, "session": null }, "response": { "error": "The error message describing the problem appears here" } }
The response section will always contain the error message, however depending upon the error extra fields may also be included which are situation specific.
In the event an error occurs, you should retry your request later and/or review your input to the API call.