DocsError codes

precondition_required

Something must happen before this request is allowed.

On this page
428HTTP 428 · Precondition Required

What it means#

Something must happen before this request is allowed.

Retry after fixing

Retrying unchanged will not help. Correct the cause, then send it again.

What causes it#

  • A step earlier in the flow has not completed.
  • The resource requires configuration that has not been supplied.

How to fix it#

  • Read `detail` — it names the precondition.
  • For the chat flow specifically, the common case is `lead_required`.

What the response looks like#

428 application/problem+json
{
  "error": {
    "code": "precondition_required",
    "message": "Something must happen before this request is allowed",
    "request_id": "7cb7f7862a82425d8e4c3fb8a497dfe6"
  },
  "type": "https://integrable.cloud/docs/errors/precondition_required",
  "title": "Precondition Required",
  "status": 428,
  "detail": "Something must happen before this request is allowed",
  "instance": "/api/agents/01a0652b-3713-7ea1-a6c9-2e895389ec34"
}

Branch on error.code, not on the message — the code is stable, the sentence is not. Log request_id either way.

Still stuck#

Quote the request_id from the response — hello@integrable.cloud. It is what lets us find the exact request. The full list of codes is at Error codes, and the conventions every endpoint shares are in Retries, versioning and limits.

Something unclear or missing? Tell us and we’ll fix it.