These are the conventional HTTP response codes to indicate the failure of an API request.
| Status Code | Meaning | Description |
|---|---|---|
| 2xx | Success | The request succeeded. Everything worked as expected. Check the property hasErrors contained in the response object to check if there is a controlled error. |
| 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 to have more detailed information and understand the change 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 Read Authentication section to know how to authenticate your requests. |
| 403 | Forbidden | The API token provided does not have the permissions to perform the request. This is mainly due to the role associated with the user performing the request. See permissions associated with your role: user permissions per role. |
| 404 | Not found | The requested resource does not exist. Most of the time, it means that the resource has been deleted. |
| 5xx | Server Errors | The request is valid but something when wrong on our side. These are rare. |