Create an approval definition

A definition names the stages a record passes through and who approves each one.

POST/api/v1/approval-definitions

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

Header parameters

Idempotency-Keystringrequired

Replays the first answer for a repeated request

min length 8 · max length 128

Request body

requiredapplication/json

labelstringrequired

min length 1 · max length 120

stagesobject[]required

min items 1 · max items 3

Show properties

Array of object

approverUserIdstringrequired

min length 1 · max length 255

labelstringrequired

min length 1 · max length 120

objectIdstringrequired

min length 1 · max length 255

versioninteger

min 1 · max 2147483647 · default: 1

Responses

201

The definition was created

idstringrequired

min length 1 · max length 255

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/approval-definitions' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Idempotency-Key: stringst' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "label": "string",
  "stages": [
    {
      "approverUserId": "string",
      "label": "string"
    }
  ],
  "objectId": "string",
  "version": 1
}'

const response = await fetch("/api/v1/api/v1/approval-definitions", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Idempotency-Key": "stringst",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"label\": \"string\",\n  \"stages\": [\n    {\n      \"approverUserId\": \"string\",\n      \"label\": \"string\"\n    }\n  ],\n  \"objectId\": \"string\",\n  \"version\": 1\n}"
});

import requests

response = requests.post(
    "/api/v1/api/v1/approval-definitions",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Idempotency-Key": "stringst",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"label\": \"string\",\n  \"stages\": [\n    {\n      \"approverUserId\": \"string\",\n      \"label\": \"string\"\n    }\n  ],\n  \"objectId\": \"string\",\n  \"version\": 1\n}",
)

Response

{
  "id": "string"
}

{
  "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"
}