Archive a Stage

Archives a stage.

Updated

POST
/v1/approval-flows/{flow}/stages/{stage}/archive
curl -X POST "https://api.orshot.com/v1/approval-flows/<FLOW>/stages/<STAGE>/archive" \
  -H "Authorization: Bearer <ORSHOT_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "confirm": true,
    "moveItemsTo": "<MOVE_ITEMS_TO>"
  }'

Archives a stage. If templates sit in it, say where they go with moveItemsTo. Other stages whose approvals or change requests went to it are re-pointed in the same request (to where it sent them, else the next stage, else they stay in place); rerouted lists each change. Reviewers can't change stages. Destructive: ask the person first and pass confirm: true.

This is destructive: send "confirm": true. Agents must ask the person before calling it.

Endpoint#

Endpoint
https://api.orshot.com/v1/approval-flows/:flow/stages/:stage/archive

Path Parameters#

ParameterTypeRequiredDescription
flowStringYesThe approval flow's id or slug. A number is an id, anything else a slug.
stageStringYesThe stage's id or slug. A number is an id, anything else a slug.

Request Body#

ParameterTypeRequiredDescription
moveItemsToStringNoWhere templates in this stage go. Required when it has templates. A number is an id, anything else a slug.
confirmBooleanYesMust be true. Confirms you want to archive this stage; ask the person first. Must be true.

Headers#

HeaderRequiredDescription
AuthorizationYesBearer <API key or OAuth token>
x-workspace-idNoOAuth tokens with several workspaces: the workspace to act in. API keys ignore it.
X-Orshot-User-IdNoAPI keys only: the user id of the owner, admin or member this call is for. See Acting for a Team Member below.
X-Session-IdNoGroups the calls of one agent or MCP session in the activity history.

Acting for a Team Member#

With an API key, you can send X-Orshot-User-Id with the user id of an owner, admin or member of the workspace to make this call for them. It needs both the key's access level and that person's own access, and it's credited to them: people see "Priya Shah, via API key", and they aren't notified about their own change. See acting for a team member.

Request#

JavaScript
await fetch("https://api.orshot.com/v1/approval-flows/developers/stages/code-review/archive", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
  body: JSON.stringify({
    "confirm": true
  }),
});
JSON
{
  "stage": {
    "id": 8,
    "slug": "code-review",
    "name": "QA review",
    "color": null,
    "category": "review",
    "rules": {
      "editable": false,
      "render": {
        "image": false,
        "pdf": false,
        "video": false
      },
      "enter": {
        "from": "any",
        "requireComment": false,
        "requires": "contribute"
      },
      "approval": {
        "mode": "any",
        "count": 1,
        "allowSelf": false,
        "perOutput": false,
        "allowConditions": false
      },
      "next": {
        "onApproved": null,
        "onChangesRequested": null
      },
      "onEdit": "require_reapproval",
      "dueHours": null
    },
    "sortKey": "r",
    "archivedAt": "2026-09-28T09:30:00.000Z"
  },
  "movedItems": 0,
  "rerouted": [],
  "warnings": []
}

Response Fields#

Responds 200 with:

FieldTypeDescription
stageObjectOne ApprovalStage, fields below.
stage.idIntegerNumeric id.
stage.slugString
stage.nameStringDisplay name.
stage.colorStringOne of subtle, blue, green, amber, rose, orange, purple. The color of the stage's chips and of the dot on its board column. A stage has none by default (null): a plain chip, no dot. Can be null.
stage.categoryStringOne of open, review, approved, done, rejected, archived.
stage.rulesObjectStage rules v1 with every default filled.
stage.sortKeyStringPosition in its list, as sortable text.
stage.itemCountInteger
stage.archivedAtStringISO 8601 timestamp. Can be null.
movedItemsIntegerHow many templates moved to the stage named in moveItemsTo.
reroutedObject{ stage, route, to }. [].
warningsArrayNon-blocking notices, each { code, message? }, for example no_approver. Always present on writes, empty when there is nothing to say.

Error Responses#

Every error has the same body: error, code, message and helpUrl, plus the fields that apply (required, role, context, blockers, violations, issues, current). Branch on error; code is more specific. See the error reference.

Status CodeErrorDescription
401oauth_token_invalidThe OAuth token is invalid, expired or revoked.
403api_key_missingNo Authorization: Bearer header.
403permission_deniedYou don't have access to do this. Ask an owner or admin. code names the capability, for example approval.item.decide_denied; required and role say what was missing. With code: insufficient_scope: the OAuth token lacks workspace:approvals:admin. With code: approval.member_header_not_member: X-Orshot-User-Id names someone who isn't an owner, admin or member of the workspace now. With code: approval.member_header_not_allowed: an OAuth token sent X-Orshot-User-Id.
403plan_requiredThe workspace's plan doesn't include Approvals, or doesn't include this part of it.
403enterprise_api_requiredUsing approvals with an API key needs an Enterprise plan. Contact hi@orshot.com to turn it on.
404not_foundThis doesn't exist or isn't available to you. Reviewers get this, never 403, for flows and templates outside their access.
422validation_failedSome fields aren't valid: the fields listed in issues. issues lists each field with a path and a reason.
422validation_failedWith code: approval.member_header_invalid: X-Orshot-User-Id isn't a user id.
429rate_limit_exceededMore than 120 approvals requests in a minute from one person or key. Wait for Retry-After.
503approvals_unavailableApprovals aren't available right now. Try again in a moment. Also returned while approvals are not switched on for the API.
Was this page helpful?

Ready to automate?

Start rendering images, PDFs and videos from your templates in under 2 minutes. Free plan, no credit card.

Get your API key
  • Image, PDF and video generation via API
  • Visual editor with AI and smart layouts
  • Zapier, Make, MCP and 50+ integrations
  • White-label embed for your own app
  • 100 free credits a month, no credit card required