REST API supported headers

The REST API provides support for various headers. Some headers are mandatory for specific APIs and HTTP methods.

Data format headers

The Accept and Content-Type request headers are required for proper data formatting for requests that contain a request body or response body. These request headers support the following values:

  • Accept: application/json, application/xml
  • Content-Type: application/json, application/xml
    Note: The Attachment API accepts all Content-Type values (*/*). Specify the file content type when uploading an attachment. The content type is stored with file metadata allowing other tools to correctly identify and parse the file.

POST, PUT, PATCH, and DELETE operations require you to provide both headers. GET operations require only the Accept header. Failing to provide the required headers results in a 400 Bad Request error.

Other headers

All requests may contain an authentication header that specifies the user credentials to authenticate with.

You can override the HTTP method, such as GET or POST, by setting the X-http-method-override header.