Options
All
  • Public
  • Public/Protected
  • All
Menu

API response returned in the event of a (non-200) API response.

An error has occurred if the HTTP status code is not 200. Errors can range from the a benign 404 (resource not found) to more urgent errors (your API Key ran out of credit, failed authentication, etc).

Hierarchy

Index

Properties

Properties

code

code: number

Custom response code returned by API.

The response codes first 3 digits, reflects the HTTP status. e.g. 2000 would accompany a 200 OK HTTP status.

We do not recommend performing > or < type comparison operations on code even though its type is number. This prohibits us from producing more than 10 response codes per HTTP status.

message

message: string

Human readable success or error message returned by API.