PRprocess
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

Request

  • Base URL
    https://public-api.process.st/api/v1.1
  • URL
    https://public-api.process.st/api/v1.1/workflow-runs/{workflowRunId}/approvals
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

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": "kZeKwSTm6CIBoZxtgBxwgw",
  "subjectTaskId": "kZeKwSTm6CIBoZxtgBxwgw"
}

Changes

No recorded changes to this operation across all 16 revisions of this API.