Skip to main content
When a request fails, the gateway returns a problem response with Content-Type: application/problem+json and a consistent shape. The HTTP status is what you branch on; the body explains the detail.

Problem shape

string
A stable URI identifying the error category, under https://errors.zeam.app/.
string
Short, human-readable summary of the category.
integer
The HTTP status code, repeated in the body.
string
A human-readable, actionable explanation of this specific failure.
string
The path that produced the error.
string
Mirrors the X-Request-Id response header. Quote it in support requests.
array
Field-level validation failures, when applicable. Each item has a field and a message.

Error catalogue

Handling guidance

  • Branch on the HTTP status, then read type for the specific category.
  • 401 is intentionally generic and never says which credential failed. Re-authenticate and retry with valid credentials.
  • 429, 502, 504 are transient. Retry with backoff; for 429, wait for Retry-After.
  • 400, 422 are caused by the request. Fix the input using detail and errors, then retry.
  • 412 means a required header is missing; add x-association-id and retry.
  • 409 means the resource already exists; reconcile instead of recreating.
  • Always capture requestId so Zeam can trace the exact request.