Errors

The help desk's API uses conventional HTTP response codes to indicate the success or failure of an API request. Response codes in the 2xx range indicates success. Codes in the 4xx range indicates a failure due issues on the request provided (e.g., required parameter is missing, maximum parameter length reached, etc). Codes in the 5xx range indicates a server side error, if you are using the self-hosted application, you should check your app's log files to see what happened.

Here's a list of all the HTTP codes used and their meaning:

Code Meaning
200 Success -- Everything went smoothly.
201 Created -- Resource was created successfully.
204 No Content -- Everything went smoothly and an empty response was given. Commonly used when deleting resources.
400 Bad Request -- Your request is invalid.
401 Unauthorized -- Your API Access Token is wrong.
403 Forbidden -- You are not allowed to access the requested resource.
404 Not Found -- The requested resource could not be found.
405 Method Not Allowed -- You tried to access a resource with an invalid HTTP method. For example, sending a POST request on a GET only endpoint.
406 Not Acceptable -- You requested a format that isn't json.
422 Unprocessable entity -- There are validation errors that you should fix.
429 Too Many Requests -- You're requesting too many resources! Slow down!
500 Internal Server Error -- There was a problem on the server.
503 Service Unavailable -- Application is offline for maintenance.