Decide an approval

/v1/companies/{campus}/approvals/{ap}

Approve or reject a pending gate. Approving a tool permission also resumes the execution that paused for it, once; that part never fails the decision (see continue_error). A reject leaves the execution paused. An approval that is not pending, or not yours to decide, is refused.

Authorizations

Authorizationstringheaderrequired

Bearer token: Authorization: Bearer ozk_…. ozk_ platform API key (Authorization: Bearer ozk_…)

Path parameters

campusstringrequired

The company’s slug (plunge), never a row id

apstringrequired

Approval id (from the door: GET …/approvals)

Query parameters

formatenum<string>

Response format; overrides Accept (an unknown value is 400 invalid_format)

Available options: json, yaml, markdown, text

Body

application/json
text/yaml

decisionenum<string>required

Available options: approve, reject

notestring

Maximum string length: 65536

Response

The decision as recorded Response format negotiates via the format field, an Accept header (application/json, text/yaml, text/markdown, text/plain), or the request Content-Type mirror; default JSON.

application/json
text/yaml
text/markdown
text/plain

approvalobject

Show child attributes

idstring

item_idstring

buildingstring

stepstring

gatestring

tierstring | null

statusenum<string>

Available options: pending, approved, rejected, expired

payload_jsonstring

execution_idstring | null

For a tool_permission gate raised inside an office: the paused execution

requested_atstring

expires_atstring

decided_atstring | null

decided_bystring | null

auto, timeout, user:<id>, team:<id> or node

notestring | null

execution_idstring

Present for a tool permission: the execution that paused for it

continuedboolean

Present with execution_id: true when an approve resumed that execution. A reject leaves it paused (false, no error)

continue_errorobject

The approve was recorded but the execution could not be resumed; answer it by hand with POST /v1/executions/{id}/continue

Show child attributes

codeenum<string>

Available options: not_paused, session_expired, execution_not_found, continue_failed

messagestring

invalid_json — body is not valid JSON or YAML; invalid_format — format must be one of json, yaml, markdown, text

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

unauthorized — missing, invalid or revoked ozk_ key

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

company_not_found — no company with that slug for this account (a foreign slug answers the same); or no approval with that id in this company; not_found — no route for this method on this path: every other method answers it

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

the approval was already decided or expired, or is not yours to decide; nothing changed

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

invalid_params — a field failed validation; nothing was written

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

upstream_error — the company service is unavailable; retry

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

not_enabled — the company service is not deployed on this tier

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

import os import requests response = requests.post( "https://api.plungeai.com/v1/companies/{campus}/approvals/{ap}", headers={"Authorization": f"Bearer {os.environ['PLUNGE_API_KEY']}"}, json={ "decision": "approve", }, ) if not response.ok: raise SystemExit(f"{response.status_code} {response.headers.get('X-Error-Code')}") print(response.json())

const response = await fetch('https://api.plungeai.com/v1/companies/{campus}/approvals/{ap}', { method: 'POST', headers: { Authorization: `Bearer ${process.env.PLUNGE_API_KEY}`, 'Content-Type': 'application/json', }, body: JSON.stringify({ "decision": "approve" }), }) if (!response.ok) throw new Error(`${response.status} ${response.headers.get('X-Error-Code')}`) console.log(await response.json())

import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; public class Main { public static void main(String[] args) throws Exception { HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.plungeai.com/v1/companies/{campus}/approvals/{ap}")) .header("Authorization", "Bearer " + System.getenv("PLUNGE_API_KEY")) .header("Content-Type", "application/json") .POST(HttpRequest.BodyPublishers.ofString("{\"decision\":\"approve\"}")) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); if (response.statusCode() >= 400) { System.out.println(response.statusCode() + " " + response.headers().firstValue("X-Error-Code").orElse("")); return; } System.out.println(response.body()); } }

{ "approval": { "id": "<string>", "item_id": "<string>", "building": "<string>", "step": "<string>", "gate": "<string>", "tier": "<string>", "status": "pending", "payload_json": "<string>", "execution_id": "<string>", "requested_at": "<string>", "expires_at": "<string>", "decided_at": "<string>", "decided_by": "<string>", "note": "<string>" }, "execution_id": "<string>", "continued": true, "continue_error": { "code": "not_paused", "message": "<string>" } }

Decide an approval

Authorizations

Path parameters

Query parameters

Body

Response

Planned: TI-33

Planned: TI-34