Take a Template Out of an Approval Flow
Takes a template out of an approval flow.
Updated
/v1/approval-flows/{flow}/items/{item}/removecurl -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>"
}'const res = await fetch("https://api.orshot.com/v1/approval-flows/<FLOW>/items/<ITEM>/remove", {
method: "POST",
headers: {
"Content-Type": "application/json",
Authorization: "Bearer <ORSHOT_API_KEY>",
},
body: JSON.stringify({
"confirm": true,
"reason": "<REASON>"
}),
});
const data = await res.json();import requests
response = requests.post(
"https://api.orshot.com/v1/approval-flows/<FLOW>/items/<ITEM>/remove",
headers={"Authorization": "Bearer <ORSHOT_API_KEY>"},
json={
"confirm": True,
"reason": "<REASON>"
},
)
data = response.json()$ch = curl_init("https://api.orshot.com/v1/approval-flows/<FLOW>/items/<ITEM>/remove");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer <ORSHOT_API_KEY>",
"Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
"confirm" => true,
"reason" => "<REASON>"
]));
$data = json_decode(curl_exec($ch), true);
curl_close($ch);require "net/http"
require "json"
uri = URI("https://api.orshot.com/v1/approval-flows/<FLOW>/items/<ITEM>/remove")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer <ORSHOT_API_KEY>"
req["Content-Type"] = "application/json"
req.body = {
"confirm": true,
"reason": "<REASON>"
}.to_json
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)Enterprise Only
The Approvals API is available on Enterprise plans. This endpoint needs manage access.
See Enterprise pricing to get access.
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.
This is destructive: send "confirm": true.
Endpoint#
https://api.orshot.com/v1/approval-flows/:flow/items/:item/removePath Parameters#
| Parameter | Type | Required | Description |
|---|---|---|---|
flow | String | Yes | The approval flow's id or slug. A number is an id, anything else a slug. |
item | Integer | Yes | The approval item's id (one template in one approval flow). |
Request Body#
| Parameter | Type | Required | Description |
|---|---|---|---|
reason | String | No | Why it is being taken out. Up to 1000 characters. |
confirm | Boolean | Yes | Must be true. Confirms you want to take this template out of the approval flow. |
Headers#
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <API key or OAuth token> |
x-workspace-id | No | OAuth tokens with several workspaces: the workspace to act in. API keys ignore it. |
X-Orshot-User-Id | No | API keys only: the user id of the owner, admin or member this call is for. See Acting for a Team Member below. |
X-Session-Id | No | Groups 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#
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
}),
});{
"removed": true,
"warnings": []
}Response Fields#
Responds 200 with:
| Field | Type | Description |
|---|---|---|
removed | Boolean | Always true. |
warnings | Array | Non-blocking notices, each { code, message? }, for example no_approver. Always present on writes, empty when there is nothing to say. |
Error Responses#
Approvals errors have 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. Authentication errors (401, 403 api_key_missing, 403 invalid_api_key_or_user_id) and 429 rate_limit_exceeded use the standard API error body instead: there error is a sentence, so branch on code. 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 | invalid_api_key_or_user_id | The API key is not valid. |
| 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. |
| 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. |
| 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. |
| 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. |
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 40+ integrations
- White-label embed for your own app
- 100 free credits a month, no credit card required