Error Categories
API errors can be categorized by the errorCategory field in the error response JSON.
Because the API interacts with many outside services, not all errors have been properly categorized. Consequently, you should expect this list to grow over time. As a rule, if your software encounters an error category that it has never seen before, it should treat it the same as it does errors with a category of UNCATEGORIZED.
In practice, errors that are UNCATEGORIZED should be displayed to the user because they frequently arise from subtle carrier-specific rules, and the error messages are often useful to the user in attempting to correct the error.
As much as possible, errors that arise from improper or malformed API requests have already been categorized in the table below.
| Category | Description |
|---|---|
| UNCATEGORIZED | The error has not been categorized |
| INVALID_REQUEST | The request failed basic validation (invalid field names, incorrect types, etc.) |
| UNAUTHORIZED | The API key is missing or invalid |
| FORBIDDEN | The API key does not provide access to this resource |
| NOT_FOUND | The resource does not exist |
| METHOD_NOT_ALLOWED | The wrong HTTP method was used |
| UNSUPPORTED_MEDIA_TYPE | The wrong content-type was used |
| INTERNAL_SERVER_ERROR | An unexpected error occurred |
| DUPLICATE_USERNAME | The username given to the Create Customer endpoint is already taken |
| INVALID_USERNAME_OR_PASSWORD | Either the username or password given to the Connect Customer endpoint is invalid |