Responses
HTTP status codes returned by the API. All responses are in JSON format and contain the
code field with the status code. Errors also contain a message.
Success
Indicates that the request has succeeded. The response contains the requested data.
Indicates that the request has succeeded and a new resource has been created or updated as a result.
New person has been added
New order has been added
New product has been created
Product has been updated
Task was created
Client errors
The request could not be processed because a required parameter is missing or has a wrong value. The client SHOULD NOT repeat the request without modifications.
Bad Request
Missing Auth Token
Missing required parameters
Missing contact id
Wrong order id
Wrong value in date from or date to
The email already exists in the system
The API key or the Auth token is not valid for this request. The client MAY repeat the request with a suitable Authorization header field.
Invalid Api key
Invalid Auth Token
Api key is blocked
The api key is not enabled for the api function
Your IP address is not enabled for this api key
The Auth token is valid, but the user it is linked to does not have the right to perform this action. The message explains which right is missing.
Forbidden: <reason>
The request HTTP method is known by the server but has been disabled and cannot be used for that resource. The allowed method is shown in the documentation of each function.
Method Not Allowed
The user has sent too many requests in a given amount of time (“rate limiting”).
Too Many Requests
Server errors
The server could not complete a valid request, for example when saving data.
Calendar event could not be saved
The server is temporarily unable to handle the request, for example when a file cannot be uploaded right now.
Internal error. We can't upload your file right now.
Error response
{
"code": 401,
"message": "Invalid Auth Token"
}Check the code field in the response body. Functions that need an
Auth token are described in the documentation.