Errors

The two APIs report errors differently. The REST API uses HTTP status codes plus a JSON body. The HTTP API returns a line of plain text that you have to parse.

REST API v1

HTTP status codes

Application errors

A 400 response carries a JSON body with a numeric StatusCode and a readable StatusMessage:

{
  "StatusCode": 712,
  "StatusMessage": "Campaign Id required."
}

The codes the documentation shows:

Handle errors by the HTTP status first, then show or log StatusMessage. Do not branch on the numbers below as if they were shared with the HTTP API: the same number means different things in the two APIs (see the next section).

HTTP API error codes

The HTTP API answers every request with a line of text. A success starts with a keyword such as JOBID:, SERVICEID:, OK or 000:; a failure starts with ERR: or Err: followed by a number. Each endpoint's page lists its full set. Combined, they are:

Messages are quoted as the API returns them, spelling included, so you can match on them if you must.

Parsing tips

• Compare the start of the response case-insensitively: both ERR: and Err: occur, with and without a space after the colon.
• Err:0 on keyword lookup means available, not failure.
• Keyword credits returns 718: and 719: without the Err: prefix, and 000: on success.
• 700 alone does not tell you what is missing on send invitation; read the message text.