Response and Status Codes

HTTP Response

Responses to the REST API provide information about the result of your query/operation request. The JSON object returned maintains the same format for simplicity and ease of implementation.

Field
Description
Optional

status

String response on the result of the request. See status codes for details.

message

Detailed description of the status provided.

response

Response object. Available only in GET requests.

Status Codes

Status codes are a representation of the request status. It is recommended that you write code that gracefully handles all status codes logically to create a more seamless flow. For example, a 403 - Unauthorized request should be followed up by a fresh authentication request.

Status Code
Description

200

Success

202

Acknowledged

400

InvalidRequest

403

Unauthorized

500

InternalError

507

InsufficientCredit

Last updated