v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB

Workflows

Update Approval Status on a Workflow

Updates the status of an approval to the specified value. Approval statuses can only be updated during the Review step and when a given approval group is active (when it is that group's turn to approve).

OAuth Scope required: public.workflows.updateApprovals

patch/workflows/{id}/approvals/{roleId}

Path parameters

idstring required

The unique identifier or Ironclad ID of a workflow.

roleIdstring required

The unique identifier of the approver role whose status should be changed. This identifier can be retrieved using the GET /workflows/{id}/approvals endpoint.

Headers

x-as-user-emailstring

Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-idstring

Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Request body

status'approved' | 'pending' required

The new approval status.

Example request

{
  "user": {
    "email": "fett@intergalactic.com"
  }
}

Response

200

boolean required

Example response

true