SynqDocs
Management APIApproval requests

Approve an approval request

Makes the change as the person who asked, through the change's own route (recorded as that route records it, naming this request as `approval_id` and the MCP host's app as `act_client_id`), from the dashboard's app only, by that person only, within 15 minutes, once, and only with the `hash` the page showed (409 when the request isn't that one). A change to money, people or sign-in security (`fresh_sign_in`: billing and plans, members and invitations, roles, API keys, deleting or moving a brand, an app's addresses and how it proves itself, domains, a sign-in protection turned off) also wants a fresh sign-in: one from the last 5 minutes, or one an earlier approval relied on in the same dashboard session, until 2 hours after it (its approval window, `GET /v1/approval-window`), else 403 `fresh_sign_in_required` (sign in again with `max_age=300`). The request records the sign-in it relied on (`relied_on_sign_in`), and a sign-in from the last 5 minutes that it relied on opens that session's window. Each request is still approved on its own, with its own hash. The decision, database effect, result and audit commit together. A change its route refuses answers with that route's problem, and the request waits again. Email is queued durably with the decision and attempted after commit; temporary delivery failures retry for up to 24 hours without repeating the change. An unsent or permanently undeliverable invitation is revoked. Sending-domain registration resumes from pending_setup through background checks. Needs `org.read`; the change's own route needs its own permission. Recorded as `approval_request.approved`.

POST/v1/orgs/{org}/approval-requests/{request}/approve

Makes the change as the person who asked, through the change's own route (recorded as that route records it, naming this request as approval_id and the MCP host's app as act_client_id), from the dashboard's app only, by that person only, within 15 minutes, once, and only with the hash the page showed (409 when the request isn't that one). A change to money, people or sign-in security (fresh_sign_in: billing and plans, members and invitations, roles, API keys, deleting or moving a brand, an app's addresses and how it proves itself, domains, a sign-in protection turned off) also wants a fresh sign-in: one from the last 5 minutes, or one an earlier approval relied on in the same dashboard session, until 2 hours after it (its approval window, GET /v1/approval-window), else 403 fresh_sign_in_required (sign in again with max_age=300). The request records the sign-in it relied on (relied_on_sign_in), and a sign-in from the last 5 minutes that it relied on opens that session's window. Each request is still approved on its own, with its own hash. The decision, database effect, result and audit commit together. A change its route refuses answers with that route's problem, and the request waits again. Email is queued durably with the decision and attempted after commit; temporary delivery failures retry for up to 24 hours without repeating the change. An unsent or permanently undeliverable invitation is revoked. Sending-domain registration resumes from pending_setup through background checks. Needs org.read; the change's own route needs its own permission. Recorded as approval_request.approved.

Authorization

bearer
AuthorizationBearer <token>

An org API key (sk_live_…, sk_test_…), or an access token from the Synq issuer (the synq brand, on the accounts host) for this API.

In: header

Path Parameters

org*string

The org's id

Match^org_[0-9a-hjkmnp-tv-z]{26}$
request*string

The approval request's id

Match^apr_[0-9a-hjkmnp-tv-z]{26}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://api.synq.build/v1/orgs/org_01h455vb4pex5vsknk084sn02q/approval-requests/apr_01h455vb4pex5vsknk084sn02q/approve" \  -H "Authorization: Bearer $SYNQ_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "hash": "string"  }'
{  "id": "apr_01h455vb4pex5vsknk084sn02q",  "kind": "app.redirect_uris",  "target": {    "brand_id": "brd_01h455vb4pex5vsknk084sn02q",    "app_id": "app_01h455vb4pex5vsknk084sn02q"  },  "change": {    "redirect_uris": [      "https://acme.example/callback"    ]  },  "title": "Make a token gate",  "preview": "Set the redirect URIs of the web app “Acme web” in the brand “Acme” to 1 address. Adds https://acme.example/callback.",  "details": [    {      "field": "redirect_uris",      "label": "Redirect URIs",      "values": [        {          "text": "https://acme.example/callback",          "code": true,          "tag": "new"        }      ]    }  ],  "changes": [    {      "kind": "app.redirect_uris",      "operation": "string",      "target": {        "brand_id": "brd_01h455vb4pex5vsknk084sn02q",        "app_id": "app_01h455vb4pex5vsknk084sn02q"      },      "title": "string",      "preview": "string",      "details": [        {          "field": "redirect_uris",          "label": "Redirect URIs",          "values": [            {              "text": "https://acme.example/callback",              "code": true,              "tag": "new"            }          ]        }      ],      "result": {        "app_id": "app_01h455vb4pex5vsknk084sn02q",        "resource_id": "string"      }    }  ],  "hash": "9f2c6a…",  "status": "awaiting_approval",  "reason": "string",  "last_refusal": {    "code": "plan_feature_unavailable",    "detail": "string",    "at": "2026-10-21T12:00:00.000Z"  },  "asked_from": "string",  "asked_from_name": "Claude",  "approve_url": "https://app.acme.example",  "applied_at_once": false,  "asks_because": "sign_in_security",  "fresh_sign_in": false,  "relied_on_sign_in": {    "signed_in_at": "2026-10-21T12:00:00.000Z",    "within_window": false  },  "result": {    "app_id": "app_01h455vb4pex5vsknk084sn02q",    "invite_id": "inv_01h455vb4pex5vsknk084sn02q",    "key_id": "string",    "resource_id": "string"  },  "expires_at": "2026-10-21T12:00:00.000Z",  "decided_at": "2026-10-21T12:00:00.000Z",  "created_at": "2026-10-21T12:00:00.000Z",  "secret": "string"}

List your approval requests GET

The changes the calling person asked for from an MCP host, newest first, each as `GET …/approval-requests/{request}` answers it: what it does, its status and, while it waits, its `approve_url`. `status=awaiting_approval` lists those still waiting for them to decide (the dashboard's "Waiting for you"); left out, every status. Only the person's own: only they decide them. One about a brand they hold no role in any more isn't listed. An API key asks for none, so its list is empty. Needs `org.read`.

Add a change to an approval request still waiting POST

Adds a change, asked for as `POST …/approval-requests` asks for one, to one of the person's own requests still waiting for them, so they approve the whole plan once, at its `approve_url`. It becomes a bundle (`kind: bundle`) whose `changes` approving makes in order, all or none, with a new `hash`, so a page that showed it before is refused until it is read again; it waits 15 minutes again from now, with at most 20 changes. An invitation, an API key, a new brand and a change that makes a secret only the person should see (a web or machine app's, a new webhook's) each go on a page of their own, and can't be added or added to (409 `conflict`). Approving a bundle wants a sign-in from the last 5 minutes when any change it holds is about money, people or sign-in security. Its plan is checked as `POST …/approval-requests` checks it, with what a trial or plan change the request holds moves the org to counted, since approving makes that first. A change that doesn't always ask is made at once instead, as `POST …/approval-requests` makes it (201), and the request it names stays as it was, unless the org requires approval or the person asks to approve theirs, or only the plan a trial or plan change the request holds moves the org to takes it: that one joins the bundle, to be made after the move. People only, never an API key. Needs `org.read`, and the permission the change does. Recorded as `approval_request.change_added`.