http Status Code

The http status code indicates the result of the operation.

200 OK

When 200 OK is returned, data in JSON format will be returned with some responses. This is documented with the relevant function.

400 Bad Request

This usually indicates that a required parameter is missing. The server will provide more information in the response body (see below).

401 Unauthorized

This response indicates a problem with the supplied Bearer token, or an incorrect ClientsID, or a combination of both.

404 Not Found

This can indicate that the REST endpoint for the function being accessed does not exist, if the response body is empty.

If the REST endpoint does exist, the server will provide a JSON structure in the response body indicating the reason for the failure.

409 Conflict

This usually indicates that an operation cannot complete, because an object which is being created (or cloned) already exists, or another precondition is not satisfied. 

500 Internal Server Error

This indicates an internal server error has occurred. Please supply details of the rest call made, and the response received to the relevant support team.

Response Body

If the server can, it will provide a JSON structure in the response body indicating the reason for the failure. 

Fields

Example

For example:

{
    "status": 404,
    "error": "Dialler campaign not found"
}