Sign in
latestOpenAPI 3.1.02026-08-171503582.2 MB

6199a9464227

Tasks

Approve or reject a task

The <code>approvalTaskId</code> is the ID of the approval task and the <code>subjectTaskId</code> is the ID of the task being approved or rejected. If you don't include a subject task, all pending subject tasks of the approval task will be approved or rejected.<br> <br> A PUT request replaces all values, so all fields must be supplied in each request. To not have a comment, you may send a null value or omit the field. See the examples for more.

put/workflow-runs/{workflowRunId}/approvals

Path parameters

workflowRunIdstring required

The ID of the Workflow Run

Request body

approvalTaskIdstring required
subjectTaskIdstring
status'Approved' | 'Rejected' required

Outcome of an approval task review.

  • Approved — the reviewer accepted the subject task(s).
  • Rejected — the reviewer rejected; subject tasks return to the assignee for rework.
commentstring

Example request

{
  "approvalTaskId": "tVkDZrUZVxS-Ylkr5oVHiw",
  "subjectTaskId": "tVkDZrUZVxS-Ylkr5oVHiw"
}