Response and error codes
The success or failure of an API call is indicated by the HTTP status code returned as part of the API response.
Types of status codes
Status codes are grouped into ranges by type.
Range |
Description |
---|---|
2xx |
The call was successful. |
4xx |
The call failed due to an invalid request input. |
5xx |
The call failed due to an internal server error. |
The following table describes some example status and error codes you might see when using the API.
Code |
Description |
---|---|
200 |
The call was successful. |
400 |
Error—one or more of the fields in the request body was not provided in your call. |
403 |
Error—you do not have the user permission(s) required to perform this action. |
404 | Error—the requested resource was not found. |
503 | Error—the service is unavailable. |
Respond to errors
An error in the 4xx range indicates a problem with the information provided in your call. For example, you might have provided a resource identifier that does not exist on your account. Review your call against the API Reference documentation and validate that the resources you identified exist on your account.
An error in the 5xx range indicates a temporary problem with the service.