Tasks

Update a task

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}/tasks/{taskId}

Request

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

Path parameters

workflowRunIdstring required

The ID of the Workflow Run

taskIdstring required

The ID of the Task

Request body

status'NotCompleted' | 'Completed' required

Whether the task is complete.

  • NotCompleted — the task has not yet been checked off.
  • Completed — the task has been checked off.
dueDatestring date-time

Due date. ISO-8601 UTC.

Changes

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