Sign in
latestOpenAPI 3.1.02026-08-171503582.2 MB

6199a9464227

Workflow Tasks

Update a workflow task

Updates a workflow task on a draft workflow revision. PUT semantics: all fields must be provided. AI and Code tasks cannot have due date offsets or stop flags. Task names can include merge tag variables (e.g. {{workflow.name}}). Use the listWorkflowRevisionVariables endpoint to discover available variables.

💡 Notes for MCP clients:

  • Don't prefix task names with numbers (e.g. "1. ", "Task 1:"). The UI already shows a position number next to each task, and task order can change — hard-coded numbers go stale.
  • Consider adding content widgets to tasks with instructions, context, or guidance for the person running the workflow. Well-explained tasks make processes easier to follow.

Returns the updated task.

put/workflows/{workflowId}/revisions/{revisionId}/tasks/{taskId}

Path parameters

workflowIdstring required

The ID of the Workflow

revisionIdstring required

The ID of the Revision

taskIdstring required

The ID of the Task

Request body

namestring

Display name.

stopboolean required
hiddenByDefaultboolean required

When true, the widget is hidden by default; conditional logic rules can reveal it at runtime. Defaults to false.

dueOffsetstring

Response

Example response

{
  "data": {
    "audit": {
      "createdBy": {
        "id": "naAJxoDIuwdgNsQHGRRGqA",
        "email": "jane.doe@example.com",
        "username": "Jane Doe"
      },
      "updatedBy": {
        "id": "naAJxoDIuwdgNsQHGRRGqA",
        "email": "jane.doe@example.com",
        "username": "Jane Doe"
      }
    },
    "links": [
      {
        "href": "https://api.process.st/api/v1.1/resource/XXX"
      }
    ]
  },
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}