Errors
API request errors occur for a variety of reasons, including incorrect or missing data, missing authentication, and server issues. Use this article as a reference to understand the error types and error-related parameters that may be included in Bringg's responses to your API requests.
Error response examples:
{
"type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400",
"title": "Customer was not found by external id 11223344, Team was not found by external id 2977",
"status": 400,
"success": false
}
Coming soon.
Coming soon.
Coming soon.
Response Status Parameters
Parameter | Description |
---|---|
status enum | A code indicating the status of your request. If an error occurs, the specific error type is included. This code may also be indicated in the response as a type . Read more about error status codes.Example value: 400 |
success boolean | Indicates whether the service was completed successfully. Possible values: false - the service failed.true - the service succeeded |
title or message string | If an error occurs, a message describing the cause of the error is included. Example value: "Customer was not found by external id 12345" |
type string | If an error occurs, a URL explaining the type may be included. Example value: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400" |
Error Status Codes
Status Code | Description |
---|---|
200 | The structure of your request is valid. There may still be errors depending on the requirements of the individual service. For example, you may receive a 200 status code in a response that also includes success: false with the message "Task with external id XXX exists already" . |
400 | Bad request. This usually means that an incorrect or improperly formatted value was included in your payload. Update your payload and try again. |
401 | Unauthorized. Your payload is missing valid authentication details. Learn more aboutBringg API Access Management. |
405 | Method not allowed. The wrong HTTP request method was used. For example, you might have used GET instead of PUT. Update your method and try again. |
500 | Internal server error There is an issue with Bringg's server. Try again and contact your Bringg support representative if you continue to receive this error. |
Updated 10 months ago