Always Check Body
Never depend on an HTTP code response without the appropriate body. Every API response should include a
responsefield in the body. An HTTP code with a
resultfield may indicate the request failed, was partially processed, or was not processed at all.
Our HTTP request support is limited to a subset of RFC 2616. We do not utilize any HTTP methods in RFC 2518, RFC 3253, RFC 3648, or RFC 3744.
HTTP Request Type
Used in our API
Used for retrieving information, authentication, and files.
Used to update information.
Used to delete objects and disable settings.
This API documentation does not include every possible result for each API because many of the results are common to the API as a whole. See individual API’s for specific results associated with a given API and assume there are a wide range of possible responses for boiler plate operations, including authorization failures, format issues, or platform operational issues.
Request successes are returned with HTTP status codes starting with
2xx. Below is a partial list of responses.
The request was successful.
The input was accepted successfully.
The result may be out of date.
The request was successful but there is no response body. Generally this is not used as we try to always return a body with an implicit
The resource was reset.
The response only includes part of the request resource.
Request errors are returned with HTTP status codes starting with
4xx and server errors are start with
5xx codes. Below is a partial list of responses.
The request was invalid because the format was incorrect or the resource method was unsupported for that type.
The request was not processed because the authorization credentials were not valid or acceptable for this resource.
Payment details must be set before this action can be taken.
The request was not processed because the authorization credentials do not allow access to the requested resource.
The resource you attempted to access is invalid.
The request method is known by the server but has been disabled and cannot be used.
The input is not acceptable for this resource or for the field it was supplied with.
The request timed out internally. Re-attempt the request.
The request was rejected because of conflicting data or because it exceeded an internal limit.
The request URI or headers exceeded the maximum length supported by the server.
The request may be valid but too many requests are being made. Slow down.
The requested resource is locked temporarily. You should check the status of pending jobs.
The request has failed internally and may be partially completed. These should be generated very infrequently.
There is an internal outage in our stack.
Additional HTTP Result Codes
Other standard HTTP errors may be generated by our stack and not directly from our API.
Many resources have an access rate limit that, when exceeded, will result in a
429response and error. This is a temporary error and you should retry your request again after an interval. The length of the interval is determined by the type of rate limit exceeded and is not defined on a per-API basis or in an error response.
If you run into rate limiting issues, please contact us at [email protected]
When a resource is accessed and a process is in progress, the API may return
423Locked. This is a temporary error that occurs on operations that block system access for integrity. Retry your request in a few moments.
Updated about a year ago