Skip to main content
POST
Stop playtable runs

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of cancel_playtable_runs.

run_sid
string

This run (pt_rn_…) alone: its columns keep their auto-run queue and config.auto_run; companies it handed to a Find people search and not searched yet go back. A run already finished or cancelled answers runs []. Two scopes or none: 422.

Required string length: 18
Pattern: ^pt_rn_
field_sid
string

The column (pt_fd_…): its unfinished runs (a run over several columns stops whole), its queue and a Find people column's waiting companies sent back (backlog_cells_count), its config.auto_run off. A plain or formula column answers runs [].

Required string length: 18
Pattern: ^pt_fd_
playtable_sid
string

Every unfinished run of the table (pt_tb_…), on every tab, and every action column of it as a field_sid Stop: its auto-run queue back, its config.auto_run off.

Required string length: 18
Pattern: ^pt_tb_
dry_run
boolean

true: the counts (the runs, the queued cells that go back, the running cells that finish, charged, the columns whose auto_run goes off), nothing cancelled. Over MCP the first call runs it and carries them as preview_result; a REST caller sends it first.

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
any
required
result
object
required
meta
object
required