Errors

Every error returns a stable code, a human message and a request ID you can quote to support.

Applies to

422 response

1{
2  "error": {
3    "type": "invalid_request",
4    "code": "phone_number_invalid",
5    "message": "The 'to' field must be an E.164 phone number.",
6    "param": "to",
7    "request_id": "req_7Hc2LmQ0"
8  }
9}

Error shape

Errors use standard HTTP status codes and a JSON body with type, code, message and request_id. Branch on code, not on message: codes are stable across releases, while messages can change to become clearer.

Common status codes

400 or 422: the request is malformed or a field is invalid.
401: the API key is missing or wrong.
403: the key lacks a required scope.
429: you hit a rate limit. Retry after the Retry-After header.
5xx: something failed on our side. Retry with backoff.

Contacting support

Include the request_id from the error body. It lets support find the exact request in the logs.

Placeholder API

Fernway is a fictional product used to show how this template works. Replace these docs with your own in the CMS.

← Testing & sandbox

Pagination →