PRprocess
Workflow Runs

Update a workflow run

Changed on

A PUT request replaces all values, so all fields must be supplied in each request. To remove a due date, you may send a null value or omit the field. See the examples for more.

put/workflow-runs/{workflowRunId}

Request

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

Path parameters

workflowRunIdstring required

The ID of the Workflow Run

Request body

namestring required

The new name for the Workflow Run

status'Active' | 'Completed' | 'Archived' | 'Deleted' required

The status for the Workflow Run

sharedboolean required

Whether or not the Workflow Run is shared (i.e. can be seen without logging in)

dueDatestring date-time

The due date for the Workflow Run

Changes