ErrorEnvelope

object

errorrequired: object
error.coderequired: ErrorCode
UNAUTHENTICATED 401 · FORBIDDEN 403 · NOT_FOUND 404 · VALIDATION 422 · CONFLICT 409 · RATE_LIMITED 429 · PLAN_LIMIT 402 · INTEGRATION 502 · INTERNAL 500
error.messagerequired: string
Safe to show to the user.
error.fields: map of string
Field path → message, e.g. { "phones.0.e164": "Invalid phone number" }.
error.request_idrequired: string
Echoed in the X-Request-Id header; quote it to support.

Example

{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "string",
    "fields": {},
    "request_id": "string"
  }
}