> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getsales.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Stop playtable runs

> Stop runs, one scope: run_sid (one run), field_sid (the column: its unfinished runs and its queue) or playtable_sid (every run and action column of the table). Queued cells go back, and so do the companies a Find people column still has waiting in its search; cells a worker holds finish, charged; no refunds. A column or table Stop turns config.auto_run off (auto_run_off_field_sids). The first call stops nothing: tell the user its preview_result and that auto-run goes off, then confirm.

Contract:
- MCP tool `cancel_playtable_runs`, 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.



## OpenAPI

````yaml /api-reference/playtables/openapi.yaml post /api/playtable-runs/cancel
openapi: 3.0.3
info:
  title: 'GetSales public contract: gs.service.playtables'
  description: >-
    The data platform and the outreach engine: tables of people and companies,
    their enrichment columns, cells and runs, the data sources that feed them,
    sender profiles, the stoplist, the activity feed, the credit ledger, and the
    multichannel workflows with their per-person journeys and tasks.


    GENERATED. This document is projected from the Zod MCP tool registry in
    `product/mcp/gs.mcp` (one tool per public endpoint, 1:1). Do not edit it by
    hand; edit the tool definition and regenerate with `pnpm openapi:public`.


    Surface: the public `/api` contract of `gs.service.playtables`, 121
    operations. This is the only OpenAPI document the platform publishes.
    Internal (`/internal`) and health endpoints are deliberately absent: they
    are not part of any contract, they can change without notice, and the
    service source is their only description.


    Conventions:

    - Auth is a bearer JWT, optionally narrowed by the `Team-SID` header.

    - Every success body is an MCP envelope: `success: true` plus one typed
    `operation` shape (`search`, `get`, `create`, `update`, `delete`, `metrics`,
    `group_by`, `action`), and a `meta` block with `trace_id` for support.

    - Every failure is the same `McpError` envelope with a code from a fixed
    16-code taxonomy, so a client maps errors once.

    - Lists page with `page_size` (0 to 500, default 50) plus an opaque forward
    `cursor`; `page_size: 0` returns counts only.

    - On `GET` and `DELETE`, object-valued query parameters (`filter`, `sort`)
    travel as JSON text and array-valued ones repeat as `name[]=value`.

    - The MCP-only `_meta` field (usage analytics) never reaches the backend and
    is not part of this contract.
  version: '1.0'
  contact:
    name: GetSales
    url: https://getsales.io
    email: support@getsales.io
  license:
    name: Proprietary
    url: https://getsales.io/terms
servers:
  - url: https://api2.getsales.io/playtables/v1
    description: Production
security:
  - BearerJwt: []
    TeamSid: []
tags:
  - name: activities
    description: >-
      Registry package `mcp.playtables/activities`, served on MCP mount
      `playtables.rows`.
  - name: activity_objects
    description: >-
      Registry package `mcp.playtables/activity_objects`, served on MCP mount
      `playtables.rows`.
  - name: companies
    description: >-
      Registry package `mcp.playtables/companies`, served on MCP mount
      `playtables.rows`.
  - name: credit_ledger_entries
    description: >-
      Registry package `mcp.playtables/credit_ledger_entries`, served on MCP
      mount `workspace.billing`.
  - name: data_source_items
    description: >-
      Registry package `mcp.playtables/data_source_items`, served on MCP mount
      `playtables.sources`.
  - name: data_sources
    description: >-
      Registry package `mcp.playtables/data_sources`, served on MCP mount
      `playtables.sources`.
  - name: notes
    description: >-
      Registry package `mcp.playtables/notes`, served on MCP mount
      `playtables.crm`.
  - name: people
    description: >-
      Registry package `mcp.playtables/people`, served on MCP mount
      `playtables.rows`.
  - name: pipeline_stages
    description: >-
      Registry package `mcp.playtables/pipeline_stages`, served on MCP mount
      `playtables.crm`.
  - name: plays
    description: Registry package `mcp.playtables/plays`, served on MCP mount `signals`.
  - name: playtable_field_values
    description: >-
      Registry package `mcp.playtables/playtable_field_values`, served on MCP
      mount `playtables.columns`.
  - name: playtable_fields
    description: >-
      Registry package `mcp.playtables/playtable_fields`, served on MCP mount
      `playtables.columns`.
  - name: playtable_runs
    description: >-
      Registry package `mcp.playtables/playtable_runs`, served on MCP mount
      `playtables.columns`.
  - name: playtable_views
    description: >-
      Registry package `mcp.playtables/playtable_views`, served on MCP mount
      `playtables.tables`.
  - name: playtables
    description: >-
      Registry package `mcp.playtables/playtables`, served on MCP mount
      `playtables.tables`.
  - name: sender_profiles
    description: >-
      Registry package `mcp.playtables/sender_profiles`, served on MCP mount
      `sender-profiles`.
  - name: stoplist_entries
    description: >-
      Registry package `mcp.playtables/stoplist_entries`, served on MCP mount
      `playtables.crm`.
  - name: tags
    description: >-
      Registry package `mcp.playtables/tags`, served on MCP mount
      `playtables.crm`.
  - name: workflow_attachments
    description: >-
      Registry package `mcp.playtables/workflow_attachments`, served on MCP
      mount `playtables.workflows`.
  - name: workflow_records
    description: >-
      Registry package `mcp.playtables/workflow_records`, served on MCP mount
      `playtables.workflow-records`.
  - name: workflow_sources
    description: >-
      Registry package `mcp.playtables/workflow_sources`, served on MCP mount
      `playtables.workflows`.
  - name: workflow_tasks
    description: >-
      Registry package `mcp.playtables/workflow_tasks`, served on MCP mount
      `playtables.workflow-records`.
  - name: workflow_versions
    description: >-
      Registry package `mcp.playtables/workflow_versions`, served on MCP mount
      `playtables.workflows`.
  - name: workflows
    description: >-
      Registry package `mcp.playtables/workflows`, served on MCP mount
      `playtables.workflows`.
paths:
  /api/playtable-runs/cancel:
    post:
      tags:
        - playtable_runs
      summary: Stop playtable runs
      description: >-
        Stop runs, one scope: run_sid (one run), field_sid (the column: its
        unfinished runs and its queue) or playtable_sid (every run and action
        column of the table). Queued cells go back, and so do the companies a
        Find people column still has waiting in its search; cells a worker holds
        finish, charged; no refunds. A column or table Stop turns
        config.auto_run off (auto_run_off_field_sids). The first call stops
        nothing: tell the user its preview_result and that auto-run goes off,
        then confirm.


        Contract:

        - MCP tool `cancel_playtable_runs`, 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.
      operationId: cancel_playtable_runs
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelPlaytableRunsRequest'
      responses:
        '200':
          description: '`action` success envelope.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelPlaytableRunsResponse'
        4XX:
          $ref: '#/components/responses/McpClientError'
        5XX:
          $ref: '#/components/responses/McpServerError'
components:
  schemas:
    CancelPlaytableRunsRequest:
      type: object
      description: Request body of `cancel_playtable_runs`.
      properties:
        run_sid:
          type: string
          minLength: 18
          maxLength: 18
          pattern: ^pt_rn_
          description: >-
            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.
        field_sid:
          type: string
          minLength: 18
          maxLength: 18
          pattern: ^pt_fd_
          description: >-
            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 [].
        playtable_sid:
          type: string
          minLength: 18
          maxLength: 18
          pattern: ^pt_tb_
          description: >-
            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.
        dry_run:
          type: boolean
          description: >-
            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.
    CancelPlaytableRunsResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        operation:
          type: string
          enum:
            - action
        action:
          type: string
          description: kebab-case verb; matches the route segment.
        item: {}
        result:
          type: object
          properties:
            dry_run:
              type: boolean
              description: >-
                true: the counts below are what a stop WOULD do; nothing was
                cancelled.
            runs:
              type: array
              items:
                type: object
                properties:
                  sid:
                    type: string
                    minLength: 18
                    maxLength: 18
                    pattern: ^pt_rn_
                    description: Playtable run sid (pt_rn_…).
                  waiting:
                    type: boolean
                    description: >-
                      true: the run held no batch yet (it waited behind another
                      run on its field).
                  reverted_cells_count:
                    type: integer
                    minimum: 0
                    description: >-
                      Its queued cells sent back (on a dry run: the ones that
                      would be).
                  in_flight_cells_count:
                    type: integer
                    minimum: 0
                    description: >-
                      Its cells a worker holds right now, and the company a Find
                      people search is on: they finish and are charged either
                      way.
                required:
                  - sid
                  - waiting
                  - reverted_cells_count
                  - in_flight_cells_count
              description: >-
                The unfinished runs found, in the order they were stopped: the
                waiting ones first, then the dispatched ones.
            cancelled_count:
              type: integer
              minimum: 0
              description: >-
                Runs this call cancelled (0 on a dry run; a run that ended on
                its own meanwhile is not counted).
            reverted_cells_count:
              type: integer
              minimum: 0
              description: >-
                Queued cells sent back, the runs' and the stopped columns'
                auto-run queue: each to what it said before the run, its status
                and reason; one that said nothing to empty, or done when it
                holds a value.
            in_flight_cells_count:
              type: integer
              minimum: 0
              description: >-
                Cells that still finish and are charged: the runs' cells a
                worker holds, and the one company each stopped Find people
                search is on. Say so to the user before the stop.
            spent_credits:
              type: number
              description: >-
                The runs' spend so far, summed; the in-flight cells may still
                add to it (the ledger is truth). Spent credits are never
                refunded: receipts stand.
            backlog_cells_count:
              type: integer
              minimum: 0
              description: >-
                Cells sent back that no run's queue holds: the stopped columns'
                auto-run queue (a row that landed, a wait for the next day's
                limit) and the companies still waiting in a Find people search.
                Counted in reverted_cells_count too.
            auto_run_off_field_sids:
              type: array
              items:
                type: string
              description: >-
                The columns whose config.auto_run this Stop turned off (a dry
                run: would turn off); [] on a run_sid Stop.
                update_playtable_field with the column's config whole and
                auto_run true turns one back on, for the rows that land from
                then on.
          required:
            - dry_run
            - runs
            - cancelled_count
            - reverted_cells_count
            - in_flight_cells_count
            - spent_credits
            - backlog_cells_count
            - auto_run_off_field_sids
        meta:
          type: object
          properties:
            trace_id:
              type: string
              description: UUID v7; same 128-bit value as the X-Trace-Id header.
            span_id:
              type: string
              pattern: ^[0-9a-f]{16}$
              description: 16 hex chars, root span of this request.
            timestamp:
              type: string
              description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time.
            duration_ms:
              type: integer
              minimum: 0
              description: Server-side wall clock.
            team_sid:
              type: string
              nullable: true
              description: >-
                The team this call ran in (the token team, or the team_sid
                override). Null when unauthenticated; absent from pre-2026-08-20
                backends.
            actor_type:
              type: string
              nullable: true
              description: >-
                user | agent | api_key | system. Null when unauthenticated;
                absent from pre-2026-08-20 backends.
          required:
            - trace_id
            - span_id
            - timestamp
            - duration_ms
      required:
        - success
        - operation
        - action
        - item
        - result
        - meta
    McpError:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - validation_failed
                - nothing_to_update
                - not_found
                - relation_not_found
                - invalid_transition
                - limit_exceeded
                - payment_required
                - duplicate_rejected
                - conflict
                - delete_blocked
                - unauthorized
                - forbidden
                - rate_limited
                - internal_error
                - service_unavailable
                - not_implemented
            message:
              type: string
            recoverable:
              type: boolean
            suggestion:
              type: string
            field_errors:
              type: object
              additionalProperties:
                type: array
                items:
                  type: object
                  properties:
                    rule:
                      type: string
                    message:
                      type: string
                  required:
                    - rule
                    - message
            blockers:
              type: array
              items:
                type: object
                properties:
                  type:
                    type: string
                    description: >-
                      Machine-readable blocker type (active_flow, pending_tasks,
                      …).
                  severity:
                    type: string
                    enum:
                      - hard
                      - soft
                    description: >-
                      hard = external action required; soft = acknowledge is
                      enough.
                  description:
                    type: string
                  entity_sid:
                    type: string
                    nullable: true
                  count:
                    type: integer
                  resolution:
                    type: string
                    description: 'Hard: tool name to call. Soft: code for acknowledge[].'
                  resolution_hint:
                    type: string
                required:
                  - type
                  - severity
                  - description
                  - entity_sid
                  - resolution
                  - resolution_hint
            context:
              type: object
              additionalProperties: {}
          required:
            - code
            - message
            - recoverable
        meta:
          type: object
          properties:
            trace_id:
              type: string
              description: UUID v7; same 128-bit value as the X-Trace-Id header.
            span_id:
              type: string
              pattern: ^[0-9a-f]{16}$
              description: 16 hex chars, root span of this request.
            timestamp:
              type: string
              description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time.
            duration_ms:
              type: integer
              minimum: 0
              description: Server-side wall clock.
            team_sid:
              type: string
              nullable: true
              description: >-
                The team this call ran in (the token team, or the team_sid
                override). Null when unauthenticated; absent from pre-2026-08-20
                backends.
            actor_type:
              type: string
              nullable: true
              description: >-
                user | agent | api_key | system. Null when unauthenticated;
                absent from pre-2026-08-20 backends.
          required:
            - trace_id
            - span_id
            - timestamp
            - duration_ms
      required:
        - success
        - error
  responses:
    McpClientError:
      description: >-
        MCP error envelope. `error.code` is one of validation_failed,
        nothing_to_update, not_found, relation_not_found, invalid_transition,
        limit_exceeded, payment_required, duplicate_rejected, conflict,
        delete_blocked, unauthorized, forbidden, rate_limited, not_implemented.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/McpError'
    McpServerError:
      description: >-
        MCP error envelope with `error.code` internal_error or
        service_unavailable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/McpError'
  securitySchemes:
    BearerJwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        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.
    TeamSid:
      type: apiKey
      in: header
      name: Team-SID
      description: >-
        Team scope for tokens that do not carry one. Ignored when the token
        already names a team.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.