Errors

Error Response Types

When an error occurs while calling an API endpoint, the response will return the appropriate HTTP status code as indicated below. The following table outlines possible error type and its corresponding description and status.

Error Type	Description	Status Code
Unauthorized	The request requires authentication.	401
Forbidden	The requested action can’t be performed by this resource.	403
Payload Too Large	The request payload is too large.	413
Invalid Payload	The request payload is invalid.	400
Unsupported Media Type	The request is invalid because the content-type isn’t supported.	415
Method Not Found	The requested method doesn’t exist.	405
Resource Not Found	The requested resource doesn’t exist.	404
Invalid JSON Schema	The provided JSON schema is invalid.	400
Invalid Data Format	The provided data doesn’t respect the provided JSON schema.	400
Invalid Identifier	The provided identifier isn’t valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters.	400
Relation Conflict	The resource is related to a different resource than the one referenced in the request. This is usually caused when providing two resource identifiers that aren’t linked together.	409
Reference Constraint	The resource can’t be deleted because it’s referenced by another resource.	409
Reference Not Found	The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request.	400
Invalid Query	The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource.	400
Runtime	An error happened during the execution of a runtime (bot or integration).	400
Already Exists	The record attempted to be created already exists.	409
Rate Limited	The request has been rate-limited.	429
Payment Required	A payment is required to perform this request.	402
Quota Exceeded	The request exceeds the allowed quota. Quotas are a soft limit that can be increased.	403
Limit Exceeded	The request exceeds the allowed limit. Limits are a hard limit that can’t be increased.	413
Breaking Changes	Request payload contains breaking changes, which aren’t allowed for this resource without a version increment.	400
Resource Locked Conflict	The resource is current locked and can’t be operated on until the lock is released.	409
Unknown	An unknown error occurred	500
Internal	An internal error occurred	500

Example JSON Responses:

Unknown Error

{
  "type": "Unknown",
  "description": "An unknown error occurred",
  "status": 500
}

Payload Too Large

{
  "type": "PayloadTooLarge",
  "description": "The request payload is too large.",
  "status": 413
}