​
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 TypeDescriptionStatus Code
UnauthorizedThe request requires authentication.401
ForbiddenThe requested action can’t be performed by this resource.403
Payload Too LargeThe request payload is too large.413
Invalid PayloadThe request payload is invalid.400
Unsupported Media TypeThe request is invalid because the content-type is not supported.415
Method Not FoundThe requested method does not exist.405
Resource Not FoundThe requested resource does not exist.404
Invalid Json SchemaThe provided JSON schema is invalid.400
Invalid Data FormatThe provided data doesn’t respect the provided JSON schema.400
Invalid IdentifierThe provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters.400
Relation ConflictThe 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 ConstraintThe resource cannot be deleted because it’s referenced by another resource.409
Reference Not FoundThe provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request.400
Invalid QueryThe provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource.400
RuntimeAn error happened during the execution of a runtime (bot or integration).400
Already ExistsThe record attempted to be created already exists.409
Rate LimitedThe request has been rate-limited.429
Payment RequiredA payment is required to perform this request.402
Quota ExceededThe request exceeds the allowed quota. Quotas are a soft limit that can be increased.403
Limit ExceededThe request exceeds the allowed limit. Limits are a hard limit that cannot be increased.413
Breaking ChangesRequest payload contains breaking changes, which are not allowed for this resource without a version increment.400
Resource Locked ConflictThe resource is current locked and cannot be operated on until the lock is released.409
UnknownAn unknown error occurred500
InternalAn internal error occurred500

​
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
}