API problem detail
Bad Request
Description
This is the generic 400 problem type for requests the API gateway refuses before processing
them. The title and detail say which check failed. It is used for:
- an invalid request body or parameter;
- Invalid Filter: a
filterthat is malformed, too large, or names a non-filterable property or unsupported operator; - Invalid Page Limit and Invalid Cursor on collection reads;
- Invalid Idempotency Key (
errorCodeINVALID_IDEMPOTENCY_KEY), see Invalid Idempotency Key; - Review Confirmation Required (
errorCodeREVIEW_CONFIRMATION_REQUIRED), see Review Confirmation Required; - Invalid Payment Rail on reconciliation reads;
- a trace id that cannot be parsed.
Field-level validation failures use Form Validation or Preflight instead.
Experience API error bodies also carry errorCode, resolution, and
traceId. Branch on errorCode, not on title or
detail; see fields on every error.
How to resolve
Branch on
errorCode where one is specific, otherwise read the title and
detail and correct the request. A corrected write needs a new X-Idempotency-Key.
Retrying the identical request returns the same 400.