Intakes

Archive intake

Close an intake from any status (draft, sent, in_progress, completed) without deleting it: cancels every pending reminder, and blocks further edits, item submissions, waivers, notes and completion on the client portal — the same 409 conflict (reason intake_archived) that PATCH /v1/intakes/{id} already returns for an archived intake. The row, its items, files, and history are all kept — GET /v1/intakes/{id} keeps returning it, and the client's portal link keeps resolving with status: "archived" rather than going dead. This is the reversible counterpart to DELETE /v1/intakes/{id}, which is permanent.

post/v1/intakes/{id}/archive

Request

  • Base URL: https://api.briefgate.dev
  • URL: https://api.briefgate.dev/v1/intakes/{id}/archive
  • Auth: HTTP bearer

Path parameters

idstring required

Intake ID

Response

The now-archived intake — same single-object shape PATCH /v1/intakes/{id} returns, not the fuller GET /v1/intakes/{id} bundle (no items/progress/owner_tasks).

Example response

{
  "intake": {
    "intake_id": "in_01J9Z8X"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.