Exit workflow record

Removes the person from the workflow: any non-terminal status → exited (terminal), finished_at stamped, open pending/scheduled tasks cancelled in the same transaction (result.cancelled_tasks_count). Already-dispatched send commands are NOT recalled - Messaging's final gate and expires_at bound them. The row survives as membership history; the (workflow, person) UNIQUE keeps re-enrollment blocked. Repeat on exited → already_exited:true; completed/failed* → 409 (already finished).

Contract:

MCP tool exit_workflow_record, registry package mcp.playtables/workflow_records, 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-records/{sid}/exit

Request

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

Path parameters

sidstring required

Workflow record sid (wf_rc_…).

Request body

reasonstring

Free-form; stored in the workflow-records.exited 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.