The api will attempt to return HTTP status codes for successful and failed requests. Use these codes to determine whether the request was successful.
Note
When an error code is returned, check the “errors” property in the response object for more details.
| Code | Description | Fix |
|---|---|---|
| 200 | Successful request and response | |
| 400 | The request is not structured correctly or does not contain the correct request parameters. | Update the request structure as required. Provide the required inputs. |
| 401 | Unauthenticated - the api key provided is invalid. | Use a valid api key. |
| 403 | Permissions - the account does not have permissions to access the API. | Contact customer service to gain access to the APIs. |
| 429 | The number of requests are exceeding the rate limit. | Reduce the number of requests per second. |
| 500 | Something broke on the server. The “errors” property on the response object may not be present. The response object itself may not be returned. | Try request again then contact customer service. |