GEgetsales
workflow_tasks

Complete workflow task

Close a manual task (pending to done); the note lands in result.note and the record advances. Any other type or status is 409; a repeat answers already_completed true. A question a play asked is answered with choice: remove ends the journey, keep lets it go on, move ends it and puts the person into workflow_sid, add puts an unenrolled person there. Skipping an automated step is cancel_workflow_task; a play's draft is approve_workflow_task.

Contract:

  • MCP tool complete_workflow_task, registry package mcp.playtables/workflow_tasks, mount playtables.journeys.
  • Operation action, response envelope action.
  • Flags: none.
post/api/workflow-tasks/{sid}/complete

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

notestring

Outcome note - stored in result.note and in the manual_task_completed activity payload.

choice'remove' | 'keep' | 'move' | 'add'

A play's question (act.do = ask): one of act.options. remove = the journey ends; keep = it goes on; move = it ends and the person enters workflow_sid (default: the act's target); add = a person in no journey enters workflow_sid. Required on a question.

workflow_sidstring

The workflow a move or an add puts the person into, when the act names none.

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.