This section contains general information about how client and server errors are reported by the API. Most client errors will provide helpful information to aide in your error handling and troubleshooting.
See also: Error Responses
Table of Contents
HTTP Status Codes
Calls to the endpoints which result in an error, or which are not able to successfully find, create, or update the specified resource will return an appropriate HTTP Status Code from the following list.
Where indicated, an Error Response will be included.
|HTTP Status Code||Response||Usage|
|The expected JSON body is missing or invalid, or the request is missing required parameters.|
|A secure resource has been requested, but the proper Authentication headers have not been provided.|
|A secure resource has been requested but the provided credentials have insufficient privileges to view it.|
|A non-existent resource has been requested, or data in the request body specifies a missing or invalid object.|
|The request method (verb) is not permitted for the specified resource|
|The request has specified an unsupported |
|The request cannot be processed because there provided input did not pass validations. Additional details will be provided in errorMessage and failedValidations.|
|Errors of this type indicate an internal problem. They will not contain the standard error body described for the other types of errors. |
Any error response which includes a response body as indicated above will include the following header.
|MIME type of the response body if one is present. This will be one of the media types specified in the |
Some status codes may also include additional headers as indicated below.
|HTTP Status Code||Additional Header||Description|
|As required by RFC7235, this header returns an acceptable challenge to indicate that Basic Auth is required: |
When appropriate, the response will contain a body which will contain an Error object.
Read more about Error Responses.