> ## 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. # Create playtable run > The single entry point for every bulk operation on a playtable. Async: the created row is the progress handle: poll get_playtable_run with include progress every ~5s until progress.state is finished or cancelled. type branches the body. enrich is the only paid type (action columns over the scope; a formula column never runs, it fills through backfill_playtable_field): always estimate_playtable_run first, tell the user the cost range and set max_budget to its cost_max (exhaustion auto-cancels, reason budget_exhausted; a cap at cost_expected cancels a row short); params force_rerun re-queues done cells (re-charge consent), params cells not_run | error narrows to those. export writes the scope to CSV (params format csv, a file_url) or an external tool (write_tool_sid). import batch-promotes a data source (params data_source_sid, no scope). bulk runs tag, field, workflow, move and delete edits (params operation). scope, required for enrich, export and bulk: one form, object_sids or view_sid/filter; an empty filter is rejected, the scope is snapshotted at create; hand-picked object_sids and exclude_object_sids are capped at 10 000 each (422 scope_too_large). 409 conflict when a field already has an active run (its sid in error.context), 429 at the team concurrency cap; already_exists is always false. When NOT: single-cell fixes (update_playtable_field_value); continuous source syncing (data sources; import here is a one-shot promotion). Contract: - MCP tool `create_playtable_run`, registry package `mcp.playtables/playtable_runs`, mount `playtables.columns`. - Operation `create`, response envelope `create`. - Flags: none. ## OpenAPI ````yaml /api-reference/playtables/openapi.yaml post /api/playtable-runs 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`, 142 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://beta.getsales.io/playtables/v1 description: >- Production (the gateway path on the beta ring; the origin is provisioned per DEPLOY_MAP.md) security: - BearerJwt: [] TeamSid: [] tags: - name: activities description: >- Registry package `mcp.playtables/activities`, served on MCP mount `playtables.journeys`. - name: activity_objects description: >- Registry package `mcp.playtables/activity_objects`, served on MCP mount `playtables.people`. - name: companies description: >- Registry package `mcp.playtables/companies`, served on MCP mount `playtables.people`. - name: credit_ledger_entries description: >- Registry package `mcp.playtables/credit_ledger_entries`, served on MCP mount `id.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.pipeline`. - name: people description: >- Registry package `mcp.playtables/people`, served on MCP mount `playtables.people`. - name: pipeline_stages description: >- Registry package `mcp.playtables/pipeline_stages`, served on MCP mount `playtables.pipeline`. - name: plays description: >- Registry package `mcp.playtables/plays`, served on MCP mount `playtables.pipeline`. - 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: result_pages description: >- Registry package `mcp.playtables/result_pages`, served on MCP mount `playtables.tables`. - name: sender_profiles description: >- Registry package `mcp.playtables/sender_profiles`, served on MCP mount `playtables.sources`. - name: stoplist_entries description: >- Registry package `mcp.playtables/stoplist_entries`, served on MCP mount `playtables.stoplist`. - name: tags description: >- Registry package `mcp.playtables/tags`, served on MCP mount `playtables.pipeline`. - 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.journeys`. - 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.journeys`. - 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: post: tags: - playtable_runs summary: Create playtable run description: >- The single entry point for every bulk operation on a playtable. Async: the created row is the progress handle: poll get_playtable_run with include progress every ~5s until progress.state is finished or cancelled. type branches the body. enrich is the only paid type (action columns over the scope; a formula column never runs, it fills through backfill_playtable_field): always estimate_playtable_run first, tell the user the cost range and set max_budget to its cost_max (exhaustion auto-cancels, reason budget_exhausted; a cap at cost_expected cancels a row short); params force_rerun re-queues done cells (re-charge consent), params cells not_run | error narrows to those. export writes the scope to CSV (params format csv, a file_url) or an external tool (write_tool_sid). import batch-promotes a data source (params data_source_sid, no scope). bulk runs tag, field, workflow, move and delete edits (params operation). scope, required for enrich, export and bulk: one form, object_sids or view_sid/filter; an empty filter is rejected, the scope is snapshotted at create; hand-picked object_sids and exclude_object_sids are capped at 10 000 each (422 scope_too_large). 409 conflict when a field already has an active run (its sid in error.context), 429 at the team concurrency cap; already_exists is always false. When NOT: single-cell fixes (update_playtable_field_value); continuous source syncing (data sources; import here is a one-shot promotion). Contract: - MCP tool `create_playtable_run`, registry package `mcp.playtables/playtable_runs`, mount `playtables.columns`. - Operation `create`, response envelope `create`. - Flags: none. operationId: create_playtable_run requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreatePlaytableRunRequest' responses: '200': description: '`create` success envelope.' content: application/json: schema: $ref: '#/components/schemas/CreatePlaytableRunResponse' 4XX: $ref: '#/components/responses/McpClientError' 5XX: $ref: '#/components/responses/McpServerError' components: schemas: CreatePlaytableRunRequest: type: object description: Request body of `create_playtable_run`. properties: playtable_sid: type: string minLength: 18 maxLength: 18 pattern: ^pt_tb_ description: Parent playtable sid (pt_tb_…). object_type: type: string enum: - people - company description: 'Which tab the run targets: people | company.' type: type: string enum: - enrich - export - import - bulk description: >- enrich (PAID - estimate first, set max_budget) | export | import | bulk. Branches which fields below are required. field_sids: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^pt_fd_ minItems: 1 maxItems: 20 description: >- REQUIRED for type=enrich, forbidden otherwise (422): 1..20 action columns (a widget, a plain column or a formula column is 422; a formula column fills through backfill_playtable_field instead). scope: type: object properties: object_sids: type: array nullable: true items: type: string minLength: 18 maxLength: 18 minItems: 1 description: >- Explicit targets (cr_pp_… / cr_co_… of the run object_type), min 1, max 10 000 (a wider selection is a view/filter, optionally with exclude_object_sids). Exactly one scope form: XOR with view_sid/filter - both or neither → 422. view_sid: type: string nullable: true minLength: 18 maxLength: 18 pattern: ^pt_vw_ description: >- Saved view (pt_vw_…) - its filter AST is snapshotted into the run at create; later view edits do not retarget. Combinable with filter; XOR with object_sids. exclude_object_sids: type: array nullable: true items: type: string minLength: 18 maxLength: 18 maxItems: 10000 description: >- Rows of the view/filter form to leave out (select all minus the unticked rows), at most 10 000; never with object_sids. filter: anyOf: - type: object properties: and: type: array items: type: object additionalProperties: {} description: >- Recursive node: the same object shape repeats here. A static OpenAPI document cannot express the cycle, so this level is documented as an open object. minItems: 1 maxItems: 20 required: - and additionalProperties: false - type: object properties: or: type: array items: type: object additionalProperties: {} description: >- Recursive node: the same object shape repeats here. A static OpenAPI document cannot express the cycle, so this level is documented as an open object. minItems: 1 maxItems: 20 required: - or additionalProperties: false - type: object properties: not: type: object additionalProperties: {} description: >- Recursive node: the same object shape repeats here. A static OpenAPI document cannot express the cycle, so this level is documented as an open object. required: - not additionalProperties: false - type: object properties: any: type: object properties: path: type: string minLength: 1 description: >- Array-valued path - the only way to reach inside an array. where: type: object additionalProperties: {} description: >- Recursive node: the same object shape repeats here. A static OpenAPI document cannot express the cycle, so this level is documented as an open object. required: - path - where additionalProperties: false required: - any additionalProperties: false - type: object properties: field: type: string minLength: 1 description: >- Namespaced path: record. or a built-in object attribute; element-relative inside any.where. op: type: object properties: eq: anyOf: - type: string - type: number - type: boolean ne: anyOf: - type: string - type: number - type: boolean in: type: array items: anyOf: - type: string - type: number - type: boolean minItems: 1 maxItems: 100 nin: type: array items: anyOf: - type: string - type: number - type: boolean minItems: 1 maxItems: 100 gt: anyOf: - type: number - type: string gte: anyOf: - type: number - type: string lt: anyOf: - type: number - type: string lte: anyOf: - type: number - type: string is_null: type: boolean contains: type: string minLength: 1 not_contains: type: string minLength: 1 contains_any: type: array items: type: string minLength: 1 minItems: 1 maxItems: 50 not_contains_any: type: array items: type: string minLength: 1 minItems: 1 maxItems: 50 starts_with: type: string minLength: 1 additionalProperties: false required: - field - op additionalProperties: false - {} description: >- Ad-hoc filter AST over the tab (§4.18 atoms, depth <= 5); stored resolved. Combinable with view_sid; XOR with object_sids. An empty/match-all filter form is rejected. additionalProperties: false description: >- REQUIRED for enrich | export | bulk, forbidden for import (422). Exactly one form: object_sids XOR view_sid/filter. params: type: object properties: force_rerun: type: boolean description: >- type=enrich: also re-queue done cells (explicit re-charge consent - §4.6). Default false. cells: type: string enum: - not_run - error description: >- type=enrich: run only the cells that have not run (not_run) or only the error cells (error); omit for every cell but the done ones. Pass the same value to the estimate. format: type: string enum: - csv description: >- type=export: CSV to S3 → file_url. Alternative to write_tool_sid. write_tool_sid: type: string maxLength: 64 description: >- type=export: push rows to an external tool via this gtm-api write tool (external sid). Alternative to format. data_source_sid: type: string minLength: 18 maxLength: 18 pattern: ^ds_sc_ description: >- type=import (REQUIRED there): the data source whose items are batch-promoted. operation: type: string enum: - add_tags - remove_tags - replace_tags - set_field_value - delete_objects - add_to_workflow - cancel_from_workflows - move_to_playtable description: >- type=bulk (REQUIRED there): the bulk edit op. Its payload keys ride alongside: tag_sids[] (add / remove / replace_tags), playtable_field_sid + value (set_field_value), workflow_sid (add_to_workflow), target playtable (move_to_playtable); checked per op. description: >- Type-specific params, snapshotted into params_snapshot: enrich {force_rerun?, cells?}; export {format:"csv"} or {write_tool_sid}; import {data_source_sid}; bulk {operation, …op payload}. max_budget: type: number nullable: true description: >- Decimal credits - enrich only: hard per-run spend cap; the budget guard cancels the run when exhausted (reason=budget_exhausted). Omit/null = uncapped. Base it on the estimate cost range. required: - playtable_sid - object_type - type CreatePlaytableRunResponse: type: object properties: success: type: boolean enum: - true operation: type: string enum: - create item: type: object properties: sid: type: string team_sid: type: string playtable_sid: type: string object_type: type: string enum: - people - company type: type: string enum: - enrich - export - import - bulk field_sids: type: array nullable: true items: type: string scope: type: object nullable: true properties: object_sids: type: array nullable: true items: type: string view_sid: type: string nullable: true filter: anyOf: - type: object properties: and: type: array items: type: object additionalProperties: {} description: >- Recursive node: the same object shape repeats here. A static OpenAPI document cannot express the cycle, so this level is documented as an open object. minItems: 1 maxItems: 20 required: - and additionalProperties: false - type: object properties: or: type: array items: type: object additionalProperties: {} description: >- Recursive node: the same object shape repeats here. A static OpenAPI document cannot express the cycle, so this level is documented as an open object. minItems: 1 maxItems: 20 required: - or additionalProperties: false - type: object properties: not: type: object additionalProperties: {} description: >- Recursive node: the same object shape repeats here. A static OpenAPI document cannot express the cycle, so this level is documented as an open object. required: - not additionalProperties: false - type: object properties: any: type: object properties: path: type: string minLength: 1 description: >- Array-valued path - the only way to reach inside an array. where: type: object additionalProperties: {} description: >- Recursive node: the same object shape repeats here. A static OpenAPI document cannot express the cycle, so this level is documented as an open object. required: - path - where additionalProperties: false required: - any additionalProperties: false - type: object properties: field: type: string minLength: 1 description: >- Namespaced path: record. or a built-in object attribute; element-relative inside any.where. op: type: object properties: eq: anyOf: - type: string - type: number - type: boolean ne: anyOf: - type: string - type: number - type: boolean in: type: array items: anyOf: - type: string - type: number - type: boolean minItems: 1 maxItems: 100 nin: type: array items: anyOf: - type: string - type: number - type: boolean minItems: 1 maxItems: 100 gt: anyOf: - type: number - type: string gte: anyOf: - type: number - type: string lt: anyOf: - type: number - type: string lte: anyOf: - type: number - type: string is_null: type: boolean contains: type: string minLength: 1 not_contains: type: string minLength: 1 contains_any: type: array items: type: string minLength: 1 minItems: 1 maxItems: 50 not_contains_any: type: array items: type: string minLength: 1 minItems: 1 maxItems: 50 starts_with: type: string minLength: 1 additionalProperties: false required: - field - op additionalProperties: false - {} description: >- Filter AST: and/or/not/any nodes (depth <= 5, root counts) over {field, op} leaves; op = >=1 of the §4.18 atoms; atoms AND. required: - object_sids - view_sid - filter params_snapshot: type: object nullable: true additionalProperties: {} max_budget: type: number nullable: true estimated_cost: type: number nullable: true file_url: type: string nullable: true created_by: type: object properties: actor_type: type: string enum: - user - support - api_key - system - agent actor_sid: type: string nullable: true team_sid: type: string actor_name: type: string nullable: true description: >- The OAuth client that acted ("Claude", "n8n"); null for a user, an API key or a system job. oauth_client_sid: type: string nullable: true description: The acting OAuth client (id_oc_*); null off the OAuth path. reason: type: string nullable: true description: >- Why a system actor wrote the row (snapshot_capture_job, ...); null otherwise. permissions: type: object additionalProperties: {} description: >- Internal audit context: the grant set the actor held at write time. Not a contract. cluster_id: type: integer nullable: true description: 'Internal audit context: the cluster that served the write.' trace_id: type: string nullable: true description: >- Internal audit context: the trace id of the request that wrote the row. required: - actor_type - actor_sid - team_sid - permissions created_at: type: string finished_at: type: string nullable: true required: - sid - team_sid - playtable_sid - object_type - type - field_sids - scope - params_snapshot - max_budget - estimated_cost - file_url - created_by - created_at - finished_at already_exists: type: boolean 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 - item - already_exists - 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.