Skip to main content

Errors

ConCat uses conventional HTTP response codes to indicate the success or failure of a request.

Typically, response codes in the 2xx range indicate success, 4xx range indicate an error with the data provided in a request, while 5xx codes indicate a error with the platform.

Some 4xx codes may indicate a problem with your integration or application, such as a rate-limit error, instead of an issue with the provided data.

Base Format

{
"errors": {
"server": {},
"access": {},
"logic": {},
"resource": {},
"usage": {},
"authentication": {},
"validation": {},
"rateLimit": {},
"internal": {}
}
}

Server Errors

Server Errors indicate a problem with the ConCat platform that is not related to the data provided in the request. Usually these will accompany a 500 - Internal Server Error HTTP status code.

Attributes

hashhash, string
Required
A tracing hash of the error to provide to support.

Example

{
"errors": {
"server": {
"hash": "base64-encoded-hash"
}
}
}

Access Errors

Access Errors indicate an API authentication or permission restriction preventing the request. Usually these will accompany a 403 - Forbidden HTTP status code.

Attributes

messagestring
Required
A human-readable message describing the error.
permissionsarray of Permission (optional)
A list of permissions that are required to access the resource. May be empty or not provided if the error is not related to permissions.

Logic Errors

Logic Errors indicate an issue with the data provided in the request or some other business logic error. Usually these will accompany a 400 - Bad Request HTTP status code.

Attributes

codeLogicError
Required
A code indicating the specific logic error. See Logic Error Codes for possible values.
messagestring
Required
A human-readable message describing the error.