Update a Stage

Renames a stage or changes its color (null for none), category or rules (partial rules are merged).

Updated

PATCH
/v1/approval-flows/{flow}/stages/{stage}
curl -X PATCH "https://api.orshot.com/v1/approval-flows/<FLOW>/stages/<STAGE>" \
  -H "Authorization: Bearer <ORSHOT_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "<NAME>",
    "color": "<COLOR>",
    "category": "<CATEGORY>",
    "rules": {}
  }'

Renames a stage or changes its color (null for none), category or rules (partial rules are merged). Changing which outputs a stage renders takes effect for every template in it. Reviewers can't change stages.

Endpoint#

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

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
nameStringNoDisplay name. Up to 80 characters.
colorStringNoThe stage's color, on its chips and the dot on its board column. Leave it out or send null for no color (the default): a plain chip. One of subtle, blue, green, amber, rose, orange, purple. Can be null.
categoryStringNoOne of open, review, approved, done, rejected, archived.
rulesObjectNoStage rules to change (partial).

rules#

ParameterTypeRequiredDescription
editableBooleanNoThe design can be edited while the template is in this stage.
renderObjectNoOutput kinds the render API may produce from this stage.
enterObjectNoFields in the table below.
approvalObjectNoFields in the table below.
nextObjectNoFields in the table below.
onEditStringNoOne of require_reapproval, keep_approved_rendering.
dueHoursIntegerNoFrom 1 to 8760. Can be null.

rules.render#

ParameterTypeRequiredDescription
imageBooleanNo
pdfBooleanNo
videoBooleanNo

rules.enter#

ParameterTypeRequiredDescription
fromString or ArrayNoStages a template may come from: "any" or a list of stage slugs. Must be "any". Up to 50 items.
requireCommentBooleanNoMoving a template here needs a comment.
requiresStringNoThe grant a manual move into this stage needs. One of contribute, decide.

rules.approval#

ParameterTypeRequiredDescription
modeStringNoOne of any, all, count.
countIntegerNoFrom 1 to 50.
allowSelfBooleanNoThe person who submitted may approve (owners and admins always may).
perOutputBooleanNoApprovals name the output kinds they cover.
allowConditionsBooleanNoApprovers may attach field limits to an approval.

rules.next#

ParameterTypeRequiredDescription
onApprovedStringNoCan be null.
onChangesRequestedStringNoCan be null.

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", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
  body: JSON.stringify({
    "name": "QA review"
  }),
});
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": "n",
    "archivedAt": null
  },
  "warnings": [
    {
      "path": "stages[1].rules.next.onApproved",
      "code": "no_next_stage",
      "message": "\"QA review\" keeps approved templates in place"
    }
  ]
}

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.
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.
422no_approverNobody would be able to approve in the 'the stage' stage. Keep at least one approver there.
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