Response status codes
Each API request will receive a response with a JSON payload and a standard HTTP status code. Some API request sections include additional response status descriptions (specific to that request) to help you troubleshoot issues.
Status Code | Description |
|---|---|
200 - OK | This was a successful call and operation. The response payload will be JSON, structured according to the nature of the request. |
400 - Bad Request | There was a problem with the structure of the request or the payload. If determinable, the response payload will identify the failure in the request. A common case of this type of error is malformed JSON in the request body. A JSON validator can be used to troubleshoot these issues. |
401 - Unauthorized | Invalid credentials were passed or some other failure in authentication. |
403 - Forbidden | The request has been successfully authenticated, but authorization to access the requested resource was not granted. |
404 - Not Found | A request was made for a resource that doesn't exist. Common causes are either an improperly formed URL or an invalid API key. |
409 - Conflict | A request was made to create or update an aspect of the resource that conflicts with another. The most common reason for this code is a tenant name or user email that is already in use. |
429 - Too Many Requests | Too many requests were made within a given amount of time. This is a rate limiting feature to stop flooding the server with requests. See API Rate Limit below for more information. |
500 - Internal Server Error | This is a catch-all code response for any unhandled error that has occurred on the server. Contact BlackBerry Support for help with this issue. |
501 - Not Implemented | A request was made against a resource with an operation that has yet to be implemented. Such operations should be identified accordingly in documentation. |
Other | Contact BlackBerry Support if you encounter any status codes that are not on this list. |