Handling responses & errors from API

API requests can result in one of various success or error responses. Typically, responses are JSON objects or arrays, unless specified otherwise in this documentation

HTTP Status Description
200 Success with response body
201 Successful object creation
204 Successful operation with no body
400 Bad request, usually input error
401 Request requires authentication
403 Insufficient permissions for request
404 Referenced object is not found
500 Internal service error
503 Internal platform error

Error responses

Error responses have a non-2xx status code and a JSON body containing an error key.

{
  "error": {
    "message": "Error description",
    "type": "InputException"
  }
}
Error object attributes

message string
A human-readable error message.

type string
Class of error


Next