v1

latestOpenAPI 3.1.02026-07-222392081.7 MB

Approval workflows

Update approval workflow

Update an existing approval workflow.

put/v1/approvals/workflows/{id}

Path parameters

idstring required

Request body

namestring

Approval workflow name.

descriptionstring nullable

Approval workflow description.

applicable_flowsstring[]

Quote or subscription flows where the workflow applies.

is_activeboolean

Whether the workflow is active.

priorityinteger

Workflow priority. Lower values are evaluated first when multiple workflows match.

step_execution'sequential' | 'parallel'

How workflow steps execute. Sequential steps run by order; parallel steps run together.

email_notification_enabledboolean

Whether approvers receive email notifications for this workflow.

Example request

{
  "name": "Enterprise quote approval",
  "description": "Requires approval for high-value subscription quotes.",
  "applicable_flows": [
    "quote_subscription"
  ],
  "is_active": true,
  "priority": 10,
  "step_execution": "sequential",
  "email_notification_enabled": true,
  "rules": [
    {
      "operator": "and",
      "conditions": [
        {
          "field": "total_amount",
          "operator": "gte",
          "value": {
            "period": "months",
            "count": 12
          }
        }
      ]
    }
  ],
  "steps": [
    {
      "id": "aps_DKL4Xcb5VSa8CQ",
      "name": "Finance approval",
      "order": 1,
      "approver_requirement": "any",
      "approver_role_ids": [
        "rol_DKL4Xcb5VSa8CQ"
      ],
      "approver_user_ids": [
        "usr_DKL4Xcb5VSa8CQ"
      ]
    }
  ]
}

Response

idstring required

Approval workflow ID.

namestring required

Approval workflow name.

descriptionstring nullable required

Approval workflow description.

applicable_flowsstring[] required

Quote or subscription flows where the workflow applies.

is_activeboolean required

Whether the workflow is active.

priorityinteger required

Workflow priority. Lower values are evaluated first when multiple workflows match.

step_execution'sequential' | 'parallel' required

How workflow steps execute. Sequential steps run by order; parallel steps run together.

email_notification_enabledboolean required

Whether approvers receive email notifications for this workflow.

versioninteger required

Workflow version number.

original_workflow_idstring nullable required

Original workflow ID when this workflow is an archived version.

created_atstring date-time required

Approval workflow creation date. UTC date time string in the ISO 8601 format.

Example response

{
  "id": "apw_DKL4Xcb5VSa8CQ",
  "name": "Enterprise quote approval",
  "description": "Requires approval for high-value subscription quotes.",
  "applicable_flows": [
    "quote_subscription"
  ],
  "is_active": true,
  "priority": 10,
  "rules": [
    {
      "id": "apr_DKL4Xcb5VSa8CQ",
      "operator": "and",
      "conditions": [
        {
          "field": "total_amount",
          "operator": "gte",
          "value": {
            "period": "months",
            "count": 12
          }
        }
      ]
    }
  ],
  "step_execution": "sequential",
  "email_notification_enabled": true,
  "steps": [
    {
      "id": "aps_DKL4Xcb5VSa8CQ",
      "name": "Finance approval",
      "order": 1,
      "approver_requirement": "any",
      "approver_role_ids": [
        "rol_DKL4Xcb5VSa8CQ"
      ],
      "approver_user_ids": [
        "usr_DKL4Xcb5VSa8CQ"
      ]
    }
  ],
  "version": 1,
  "created_at": "2024-12-20T16:04:11Z"
}