You are reading version v1.2, which is archived. See the current version
Errors
How an error is written, what each member means, and how to quote it to support.
Version v1.2, updated
Every error is a problem details object (RFC 9457) with a stable code. Act on the code and the status, and log the request_id.
The problem object
422 validation_failedJSON
{
"code": "validation_failed",
"detail": "One or more request parameters are invalid.",
"errors": [
{
"field": "limit",
"message": "must be between 1 and 200"
}
],
"instance": "/v1/categories",
"request_id": "a1b2c3d4-0000-4000-8000-0000000000ee",
"status": 422,
"title": "Validation failed",
"type": "https://birp.io/developers/errors/validation_failed"
}The errors array
field is a path into what you sent: lines[1].unit_price, items[3].data.price, or a query parameter name. Fix every entry, then send the request again.
Status families
Quote the request id
When you write to support, quote the request_id and the time of the request. Never send the API key.
Every code has its own page, with its causes and fixes, in the Errors group.
Related
- handling-errors
- validation-failed
- not-found
- rate-limits