Errors

Error responses may be returned for several reasons. It is recommended to first check the HTTP status code to indicate if the request was successful:

Code	Description	Reason
200/201	Successful	-
204	Successful, but no content returned	-
400	Bad request	The request had some other issue not covered by a 422 response
401	Unauthenticated	The API key or token is invalid, expired or revoked
403	Unauthorized	The user associated with the API key or token does not have sufficient permission to perform the action
404	Endpoint Not Found	-
405	Method Not Allowed	Using the wrong HTTP verb in the request
409	Conflict	This usually occurs when attempt to create something that already exists
413	Content too large	This may be encountered when initialising a flow with a payload
415	Unsupported Media Type	The content-type header value is incorrect, please ensure it is application/json
422	Unprocessible Request	The content in the request has failed validation. Please see the response for a description of errors
429	Too Many Requests	You have hit a rate limit
500	Server Error	Something went wrong on the receiving server

The most common error is a 422 Unprocessible Request. This means that the request was valid but the server could not process it. The response will contain a JSON object with a description of the error, usually in this format:

{
 "message": "...",
 "errors": {
 "field1": [
 {"rule": "failure reason"}
 ]
 }
}

Where field1 is the name of the field that failed validation, rule is the name of the validation rule that failed, and failure reason is the reason why validation failed.