SynqDocs
Management APIApproval requests

Ask for a change, made at once or approved by the person in the dashboard

A change that widens who can get in or changes where sign-ins go, asked for from an MCP host: a new brand with a permanent issuer slug (`brand.create`), an app's redirect URIs (`app.redirect_uris`), a way to sign in an app takes or stops taking, or its test sign-ins (`app.sign_in_method`), a new app (`app.create`), an invitation (`org.invite`) an API key (`org.api_key`), or dashboard configuration (`configuration.update`: themes, brand email, APIs/scopes, token gates, sending domains and file finalization). Reads what is there as the caller and answers with `preview`, what it does in plain words, and its `hash`. A change the org's plan can't take is refused now, as approving would refuse it (403 `plan_feature_unavailable`, or `plan_quota_exceeded` for a new app or brand), naming the plan that allows it and how to move there, so nobody is asked to approve what can't be made. By default a change is made at once, answering `approved` with `applied_at_once` (recorded as `approval_request.applied`, and the change as its route records it, naming this request and the MCP host's app), and a refusal is the change's own route's, with nothing left waiting. It waits instead, and nothing changes until the same person approves it at `approve_url` in the dashboard within 15 minutes, where the org requires approval for every AI agent change or the person asks to approve theirs (`GET …/agent-approvals`), and whatever either says for money, people, sign-in security and a secret shown once (`asks_because`). Some changes always ask, and take a sign-in from the last 5 minutes to approve: money and people (billing and plans, inviting or removing members, roles, API keys, deleting or moving a brand) and sign-in security (an app’s redirect and sign-out addresses and how it proves itself, custom sign-in, sending and verified domains, turning a sign-in protection off, such as the breached-password check or PKCE, turning a token gate off, deleting it or taking a place off it, and loosening account linking). So does a change that makes a secret only you should see (a web or machine app’s client secret, a webhook’s signing secret), which shows once, on its approval page. People only, never an API key. Needs `org.read`, and asking needs the permission the change does: `org.apps.edit` for apps and the ways they take, `org.members.edit` for an invitation, `org.apiKeys.edit` (and every permission the key would hold) for an API key. Recorded as `approval_request.created`.

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

A change that widens who can get in or changes where sign-ins go, asked for from an MCP host: a new brand with a permanent issuer slug (brand.create), an app's redirect URIs (app.redirect_uris), a way to sign in an app takes or stops taking, or its test sign-ins (app.sign_in_method), a new app (app.create), an invitation (org.invite) an API key (org.api_key), or dashboard configuration (configuration.update: themes, brand email, APIs/scopes, token gates, sending domains and file finalization). Reads what is there as the caller and answers with preview, what it does in plain words, and its hash. A change the org's plan can't take is refused now, as approving would refuse it (403 plan_feature_unavailable, or plan_quota_exceeded for a new app or brand), naming the plan that allows it and how to move there, so nobody is asked to approve what can't be made. By default a change is made at once, answering approved with applied_at_once (recorded as approval_request.applied, and the change as its route records it, naming this request and the MCP host's app), and a refusal is the change's own route's, with nothing left waiting. It waits instead, and nothing changes until the same person approves it at approve_url in the dashboard within 15 minutes, where the org requires approval for every AI agent change or the person asks to approve theirs (GET …/agent-approvals), and whatever either says for money, people, sign-in security and a secret shown once (asks_because). Some changes always ask, and take a sign-in from the last 5 minutes to approve: money and people (billing and plans, inviting or removing members, roles, API keys, deleting or moving a brand) and sign-in security (an app’s redirect and sign-out addresses and how it proves itself, custom sign-in, sending and verified domains, turning a sign-in protection off, such as the breached-password check or PKCE, turning a token gate off, deleting it or taking a place off it, and loosening account linking). So does a change that makes a secret only you should see (a web or machine app’s client secret, a webhook’s signing secret), which shows once, on its approval page. People only, never an API key. Needs org.read, and asking needs the permission the change does: org.apps.edit for apps and the ways they take, org.members.edit for an invitation, org.apiKeys.edit (and every permission the key would hold) for an API key. Recorded as approval_request.created.

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 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" \  -H "Authorization: Bearer $SYNQ_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "kind": "app.redirect_uris",    "brand_id": "brd_01h455vb4pex5vsknk084sn02q",    "app_id": "app_01h455vb4pex5vsknk084sn02q",    "redirect_uris": [      "https://app.acme.example"    ]  }'
{  "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"}