GEgetsales
workflow_records

Restart workflow record from top

Start one person's journey over: open tasks are cancelled, the version and sender profile pinned again, the step reset, the first task planned now. From any status the person gate does not hold, finished or in flight. Refusals: a row the gate holds is 409 (exit is its verb); a stoplisted or duplicate person 409 conflict; an archived or unpublished workflow 409; a sender profile outside the pool 422. Every call is another restart.

Contract:

  • MCP tool restart_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}/restart

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

mode'from_start' | 'from_current'

from_start (default): the journey begins at the published version's entry step. from_current: it keeps the step it is on (the entry when the published version no longer has that step).

sender_profile_sidstring

An explicit sender profile for the restarted journey; it must be in the workflow's sender pool (422 otherwise). Absent = the workflow's rotation strategy picks again.

reasonstring

Free-form; stored in the workflow_restarted activity and the log 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.