Requests will follow the conventional HTTP response codes to indicate the success or failure of an API request. Controlled errors from our own system will only be shown if the HTTP request succeeds with a status code of 200.
Conventional HTTP Response Codes
| Status Code | Meaning | Description |
|---|---|---|
| 200 | Success | The request has succeeded. Check the hasErrors property in the returned Application Response object to see if there are any controlled errors. |
| 400 | Bad Request | The request is invalid. Mainly due to: • required parameters not specified • parameters having invalid values • unknown parameters were specified. Read the error attribute contained in the data of the HTTP response for more detailed information and to understand the changes you need to make to perform your request. |
| 401 | Unauthorized | The request was not authenticated. Mainly due to: • invalid or expired API token • missing API token See Authentication section to learn how to authenticate your requests. |
| 403 | Forbidden | The API token provided does not have permission to perform the request. Only use endpoints specified in this documentation. |
| 404 | Not Found | The requested resource does not exist. Check the endpoint being used and make sure that it exists in this documentation. |
| 429 | Too many requests | You have reached the threshold requests per minute |
| 5xx | Server Errors | The request is valid but something went wrong on our side. These are rare. |
Generic Controlled Status Code and Error Codes
| Code | Description |
|---|---|
| succeed_system_operation | Operation succeeded with no issues. hasErrors property should be false. |
| failed_system_operation | Generic failure. If error persists, contact support. |
| error_invalid_value | Generic error for invalid values being provided in the request. |