workflow_tasks

Cancel workflow task

Skip this step and keep the sequence: an open (pending or scheduled) task becomes cancelled and the record advances along the step's compiled next. Linear types only: condition, wait_for_event and dispatched tasks are 409 invalid_transition. A repeat answers already_cancelled true. A whole journey stops with pause_workflow_record or exit. A play's draft or question is skipped here (a question leaves the journey paused), and a failed or expired act (cancelled, its error kept).

Contract:

  • MCP tool cancel_workflow_task, registry package mcp.playtables/workflow_tasks, mount playtables.journeys.
  • Operation action, response envelope action.
  • Flags: dangerous: the MCP layer gates it behind a preview/commit token, and the effect cannot be undone through this API.
post/api/workflow-tasks/{sid}/cancel

Request

  • Base URL
    https://beta.getsales.io/playtables/v1
  • Auth
    HTTP bearer and API key in header Team-SID

Path parameters

sidstring required

Workflow task sid (wf_tk_…).

Request body

reasonstring

Why the step is skipped - stored in the workflow-tasks.finished event payload only (not on the row).

Response

action success envelope.

successtrue required
operation'action' required
actionstring required

kebab-case verb; matches the route segment.

Changes

No recorded changes to this operation across all 1 revision of this API.