Take a Template Out of an Approval Flow

Takes a template out of an approval flow.

Updated

POST
/v1/approval-flows/{flow}/items/{item}/remove
curl -X POST "https://api.orshot.com/v1/approval-flows/<FLOW>/items/<ITEM>/remove" \
  -H "Authorization: Bearer <ORSHOT_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "confirm": true,
    "reason": "<REASON>"
  }'

Takes a template out of an approval flow. In a flow that blocks renders this lifts the approval requirement, so it needs manage or approve rights, a reason is recorded, and admins are told. Reviewers can't take templates out, whatever their access in the flow. 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/items/:item/remove

Path Parameters#

ParameterTypeRequiredDescription
flowStringYesThe approval flow's id or slug. A number is an id, anything else a slug.
itemIntegerYesThe approval item's id (one template in one approval flow).

Request Body#

ParameterTypeRequiredDescription
reasonStringNoWhy it is being taken out. Up to 1000 characters.
confirmBooleanYesMust be true. Confirms you want to take this template out of the approval flow; 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/brand-and-legal/items/2/remove", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
  body: JSON.stringify({
    "reason": "Replaced by a new design",
    "confirm": true
  }),
});
JSON
{
  "removed": true,
  "warnings": []
}

Response Fields#

Responds 200 with:

FieldTypeDescription
removedBooleanAlways true.
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