If you are an AI agent, LLM, or automated tool, a clean Markdown version of this page is available at https://orshot.com/docs/api-reference/approvals-stages-create.md — optimized for AI and LLM tools.
The Approvals API is available on Enterprise plans, or through first-party apps (the Orshot app and the Orshot MCP server). This endpoint needs manage access.
See Enterprise pricing to get access.
Adds a stage to an approval flow. Give a name and a category (open, review, approved, done, rejected, archived); rules default sensibly for the category (approved stages are locked). Place it with after. Reviewers can't change stages.
Send an Idempotency-Key header to retry safely: a repeat within 24 hours returns the first response and changes nothing.
open, review, approved, done, rejected or archived.
color
String
No
The 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.
rules
Object
No
Stage rules to change (partial).
after
String
No
Place after this stage; null for first, omit for last. A number is an id, anything else a slug. Can be null.
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.
One 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.category
String
One of open, review, approved, done, rejected, archived.
stage.rules
Object
Stage rules v1 with every default filled.
stage.sortKey
String
Position in its list, as sortable text.
stage.itemCount
Integer
stage.archivedAt
String
ISO 8601 timestamp. Can be null.
warnings
Array
Non-blocking notices, each { code, message? }, for example no_approver. Always present on writes, empty when there is nothing to say.
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 Code
Error
Description
401
oauth_token_invalid
The OAuth token is invalid, expired or revoked.
403
api_key_missing
No Authorization: Bearer header.
403
permission_denied
You 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.
403
plan_required
The workspace's plan doesn't include Approvals, or doesn't include this part of it.
403
enterprise_api_required
Using approvals with an API key needs an Enterprise plan. Contact hi@orshot.com to turn it on.
403
flow_limit_reached
Your plan allows N stages in one approval flow. Archive one or upgrade to add more.
404
not_found
This doesn't exist or isn't available to you. Reviewers get this, never 403, for flows and templates outside their access.
409
state_conflict
With code: approval.request_in_progress: the same Idempotency-Key is still running.
422
validation_failed
Some fields aren't valid: the fields listed in issues. issues lists each field with a path and a reason.
422
validation_failed
With code: approval.member_header_invalid: X-Orshot-User-Id isn't a user id.
422
validation_failed
With code: approval.idempotency_key_reused: the Idempotency-Key was used with a different request.
429
rate_limit_exceeded
More than 120 approvals requests in a minute from one person or key. Wait for Retry-After.
503
approvals_unavailable
Approvals 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.