Exceptions
Standard HTTP error codes are utilized to relay issues with either the API itself or the incoming request data. Certain endpoint can utilize additional codes, which are documented in their OpenAPI specification.
Table of contents
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
- 404 Not Found
- 429 Too Many Request
- 500 Internal Service Error
- 502 Bad Gateway
- 503 Service Unavailable
400 Bad Request
The submitted data is considered to be invalid. When available, details on the invalid data will be returned. For example:
{
"validationErrors": [
{
"path": "mainContact.email",
"code": "49ad31ac-72ad-11eb-bd63-0242ac1c0104",
"message": "Username is already taken"
}
]
}
401 Unauthorized
Proper authentication is missing from the request, indicated by the following content:
{"message":"Authentication required"}
See Authentication for more details on how to create and use credentials.
403 Forbidden
Authentication has been successful, but the current token is not allowed to access the requested resource.
404 Not Found
The requested resource has not been found. This can be caused by a specific feature being disabled for this API instance.
429 Too Many Request
You have executed too many request to this endpoint and have to wait until you are allowed access again.
500 Internal Service Error
Something went wrong on the API side of things. The error has been automatically logged and should be resolved in the future.
502 Bad Gateway
The API is experiencing unexpected downtime.
503 Service Unavailable
An external dependency is not functional, the request should be retried later.