Share:
ClickHelp Documentation

Error Handling

If an exception occurs when processing your request, the API returns a meaningful response code and provides some details in the response body.

An API call may result in one of the response codes listed below.

Success Codes

  • 200 (OK)
    The API call was successfully executed.
  • 201 (Created)
    The API call was successfully executed and an object has been created.
  • 204 (No Content)
    The API call was successfully executed, but there is no response data to return.
Error Codes
  • 400 (Bad Request)
    The data provided in your request is invalid. For example, some required argument is missing or has a value which is not allowed (see response body for details).
  • 401 (Unauthorized)
    The user name or API Key is invalid, no login information provided, your user account is disabled or the Authorization HTTP header of your request is corrupted (see response body for details). 
  • 403 (Forbidden)
    You have no permission to work with the API or you have no permission to perform the requested action (see response body for details).
  • 404 (Not Found)
    The resource you are looking for cannot be found. This may happen if the URL you specified is invalid or the resource you refer to has been deleted.
  • 409 (Conflict)
    The action you tried to perform resulted in a data conflict, which usually means duplicated identifiers (for example, creating a user with a name that already exists). See response body for details.
  • 500 (Internal Server Error)
    Something went wrong when processing your request (see response body for details). Normally, this should not happen, so if you get this response code, this is likely to be a server-side problem. ClickHelp Support will be automatically notified if such server-side error occurs.
  • 501 (Not Implemented)
    You have attempted to do something which is not currently supported by the API. If you ever manage to get this response code, please contact us and let us know what you are trying to achieve.

For errors, the HTTP response body always contains a JSON object having the following fields:

Field Type Description
MessageString

Exception message with details.

ExceptionTypeStringThe type of the exception.
ExceptionDetailString Reserved for future use. 
StackTraceString Reserved for future use.