Decide a stage

Approving the last stage approves the request; rejecting any stage rejects it.

POST/api/v1/approvals/{id}/decisions

Authorization

AuthorizationOAuth2 access token · headerrequired

Authorization-code grant with PKCE. Clients are public and hold no secret. Discovery is published at /.well-known/oauth-authorization-server/api/auth.

Scopes:api.access

Path parameters

idstringrequired

An approval request's id

min length 1 · max length 255

Header parameters

Idempotency-Keystringrequired

Replays the first answer for a repeated request

min length 8 · max length 128

Request body

requiredapplication/json

commentstring

max length 4000 · default: ""

decisionstringrequired

Allowed:approvereject

stageintegerrequired

min 1 · max 3

Responses

200

Where the request stands after the decision

activeStageintegerrequired

min -9007199254740991 · max 9007199254740991

idstringrequired

min length 1 · max length 255

stateApprovalStaterequired

Allowed:pendingapprovedrejectedwithdrawn

400

The request body, query or parameters were refused

codestringrequired

Allowed:invalid_inputnot_foundconflictforbidden

detailany

errorstringrequired

reasonstring

401

The access token is missing, invalid or revoked

errorstringrequired

403

The tenant's module is off, or the token's scope or the member's role does not permit the action

codestringrequired

Allowed:invalid_inputnot_foundconflictforbidden

detailany

errorstringrequired

reasonstring

404

No such record, or none the caller may read

codestringrequired

Allowed:invalid_inputnot_foundconflictforbidden

detailany

errorstringrequired

reasonstring

409

The operation conflicts with the current state

codestringrequired

Allowed:invalid_inputnot_foundconflictforbidden

detailany

errorstringrequired

reasonstring

413

The request exceeds the route's body limit

errorstringrequired

500

An unexpected failure

errorstringrequired

Request

curl -X POST '/api/v1/api/v1/approvals/string/decisions' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Idempotency-Key: stringst' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "comment": "",
  "decision": "approve",
  "stage": 1
}'

const response = await fetch("/api/v1/api/v1/approvals/string/decisions", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Idempotency-Key": "stringst",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"comment\": \"\",\n  \"decision\": \"approve\",\n  \"stage\": 1\n}"
});

import requests

response = requests.post(
    "/api/v1/api/v1/approvals/string/decisions",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Idempotency-Key": "stringst",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"comment\": \"\",\n  \"decision\": \"approve\",\n  \"stage\": 1\n}",
)

Response

{
  "activeStage": -9007199254740991,
  "id": "string",
  "state": "pending"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "error": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}