playtable_runs

Cancel playtable run

Stop an active run: cancels the Laravel batch (in-flight steps finish their current step, remaining jobs no-op), reverts still-queued cells, stamps finished_at, emits playtable-runs.cancelled (reason=user). Spent credits are NOT refunded - receipts stand; result carries spent_credits so far (may still grow from in-flight steps) and reverted_cells_count. Idempotent on an already-cancelled run (already_cancelled:true); a normally finished run → 409 conflict.

Contract:

  • MCP tool cancel_playtable_run, registry package mcp.playtables/playtable_runs, mount playtables.columns.
  • 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/playtable-runs/{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

Playtable run sid (pt_rn_…).

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.