> ## 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. # Update workflow source > Rename, toggle auto_add, repoint view_sid (type=view) or replace filter (type=filter) - a payload key that does not match the source's immutable type → 422. Takes effect next poll cycle; turning auto_add on enqueues an immediate sweep. Already-enrolled records are never touched - entry is one-way (removal = workflow-records exit). Use {auto_add:false} to stop new entries while journeys keep running (NOT workflows pause - that freezes dispatch). Archived parent → 409 conflict. Contract: - MCP tool `update_workflow_source`, registry package `mcp.playtables/workflow_sources`, mount `playtables.workflows`. - Operation `update`, response envelope `update`. - Flags: none. ## OpenAPI ````yaml /api-reference/playtables/openapi.yaml patch /api/workflow-sources/{sid} 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/workflow-sources/{sid}: patch: tags: - workflow_sources summary: Update workflow source description: >- Rename, toggle auto_add, repoint view_sid (type=view) or replace filter (type=filter) - a payload key that does not match the source's immutable type → 422. Takes effect next poll cycle; turning auto_add on enqueues an immediate sweep. Already-enrolled records are never touched - entry is one-way (removal = workflow-records exit). Use {auto_add:false} to stop new entries while journeys keep running (NOT workflows pause - that freezes dispatch). Archived parent → 409 conflict. Contract: - MCP tool `update_workflow_source`, registry package `mcp.playtables/workflow_sources`, mount `playtables.workflows`. - Operation `update`, response envelope `update`. - Flags: none. operationId: update_workflow_source parameters: - name: sid in: path required: true description: Workflow source sid (wf_sr_…). schema: type: string minLength: 18 maxLength: 18 pattern: ^wf_sr_ description: Workflow source sid (wf_sr_…). requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/UpdateWorkflowSourceRequest' responses: '200': description: '`update` success envelope.' content: application/json: schema: $ref: '#/components/schemas/UpdateWorkflowSourceResponse' 4XX: $ref: '#/components/responses/McpClientError' 5XX: $ref: '#/components/responses/McpServerError' components: schemas: UpdateWorkflowSourceRequest: type: object description: Request body of `update_workflow_source`. properties: event: type: string enum: - linkedin_connection_request_accepted - linkedin_message_replied - linkedin_inmail_replied - email_replied - email_opened - email_link_clicked - linkedin_invitation_received - linkedin_followed - website_visited - website_key_page_visited - website_form_submitted description: 'type=event only: replace the enrolling activity type.' name: type: string nullable: true minLength: 1 maxLength: 255 description: New label; null clears it. auto_add: type: boolean description: >- Poller toggle. Turning it on enqueues an immediate sweep; true on a manual source → 422. view_sid: type: string minLength: 18 maxLength: 18 pattern: ^pt_vw_ description: >- Repoint a type=view source at another live view (pt_vw_…). Sent on a non-view source → 422; cannot be nulled - a view source always points at a view. 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: built-in people attribute or "record." resolved per person's playtable (missing slug ⇒ leaf false); element-relative inside any.where. op: type: object properties: eq: anyOf: - type: string - type: number - type: boolean description: 'Scalar equality. eq: null is rejected - use is_null.' ne: anyOf: - type: string - type: number - type: boolean description: 'Scalar inequality. ne: null is rejected - use is_null.' in: type: array items: anyOf: - type: string - type: number - type: boolean minItems: 1 maxItems: 100 description: Value in list, 1..100 scalars. nin: type: array items: anyOf: - type: string - type: number - type: boolean minItems: 1 maxItems: 100 description: Value not in list, 1..100 scalars. gt: anyOf: - type: number - type: string description: Greater than; string operand = ISO 8601 datetime. gte: anyOf: - type: number - type: string description: '>= bound; pair with lte in the SAME op for a range.' lt: anyOf: - type: number - type: string description: Less than; string operand = ISO 8601 datetime. lte: anyOf: - type: number - type: string description: <= bound; pair with gte in the SAME op for a range. is_null: type: boolean description: true = absent-or-null; false = present and non-null. contains: type: string minLength: 1 description: Case-insensitive substring match. not_contains: type: string minLength: 1 description: Negated case-insensitive substring match. contains_any: type: array items: type: string minLength: 1 minItems: 1 maxItems: 50 description: 1..50 strings; true when ANY is a ci substring. not_contains_any: type: array items: type: string minLength: 1 minItems: 1 maxItems: 50 description: 1..50 strings; true when NONE is a ci substring. starts_with: type: string minLength: 1 description: Case-insensitive prefix match. additionalProperties: false required: - field - op additionalProperties: false description: >- Full replace of a type=filter source's AST (not a merge). Sent on a non-filter source → 422. The next cycle honors it; already-enrolled records untouched. active_limit: type: integer nullable: true minimum: 1 description: >- Enrollment throttle: max simultaneous in-flight records from this source; null clears it (unlimited). Lowering below current in-flight evicts no one - new entries just wait. coworkers_limit: type: integer nullable: true minimum: 1 description: >- Enrollment throttle: max simultaneous in-flight records from this source per company; null clears it (unlimited). UpdateWorkflowSourceResponse: type: object properties: success: type: boolean enum: - true operation: type: string enum: - update item: type: object properties: sid: type: string description: Source sid (wf_sr_…). team_sid: type: string description: Owning team (ts_tm_…, external - gs.service.id). workflow_sid: type: string description: '[ro] Parent workflow (wf_wf_…) - see ./workflows.md.' view_sid: type: string nullable: true description: >- Audience view (pt_vw_…) - set on type=view only, null otherwise; repointable via update - see ./playtable_views.md. name: type: string nullable: true description: Optional label ("Conference batch"), max 255; null = unlabeled. type: type: string enum: - view - filter - manual - event description: >- [ro] view = playtable view membership | filter = inline AST | manual = hand-picked people. Immutable - repoint = delete + create. event: type: string nullable: true enum: - linkedin_connection_request_accepted - linkedin_message_replied - linkedin_inmail_replied - email_replied - email_opened - email_link_clicked - linkedin_invitation_received - linkedin_followed - website_visited - website_key_page_visited - website_form_submitted description: >- type=event only: the activity type that enrolls a person (required at create for an event source, 422 otherwise); null on the other types. 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: built-in people attribute or "record." resolved per person's playtable (missing slug ⇒ leaf false); element-relative inside any.where. op: type: object properties: eq: anyOf: - type: string - type: number - type: boolean description: 'Scalar equality. eq: null is rejected - use is_null.' ne: anyOf: - type: string - type: number - type: boolean description: >- Scalar inequality. ne: null is rejected - use is_null. in: type: array items: anyOf: - type: string - type: number - type: boolean minItems: 1 maxItems: 100 description: Value in list, 1..100 scalars. nin: type: array items: anyOf: - type: string - type: number - type: boolean minItems: 1 maxItems: 100 description: Value not in list, 1..100 scalars. gt: anyOf: - type: number - type: string description: Greater than; string operand = ISO 8601 datetime. gte: anyOf: - type: number - type: string description: '>= bound; pair with lte in the SAME op for a range.' lt: anyOf: - type: number - type: string description: Less than; string operand = ISO 8601 datetime. lte: anyOf: - type: number - type: string description: <= bound; pair with gte in the SAME op for a range. is_null: type: boolean description: true = absent-or-null; false = present and non-null. contains: type: string minLength: 1 description: Case-insensitive substring match. not_contains: type: string minLength: 1 description: Negated case-insensitive substring match. contains_any: type: array items: type: string minLength: 1 minItems: 1 maxItems: 50 description: 1..50 strings; true when ANY is a ci substring. not_contains_any: type: array items: type: string minLength: 1 minItems: 1 maxItems: 50 description: 1..50 strings; true when NONE is a ci substring. starts_with: type: string minLength: 1 description: Case-insensitive prefix match. additionalProperties: false required: - field - op additionalProperties: false - {} description: >- Inline audience AST (type=filter only, null otherwise) over the team's people; ES resolves membership, record. leaves resolve per person's playtable (missing slug ⇒ false). auto_add: type: boolean description: >- Poller toggle (view/filter): true = every cycle (~10 min) ES lists current audience members and MySQL decides entry; false = dormant pointer. Always false on manual. active_limit: type: integer nullable: true minimum: 1 description: >- Max simultaneous in-flight (non-terminal) records entered via THIS source; null = unlimited. Reached => new candidates wait (blocked_limit_count). coworkers_limit: type: integer nullable: true minimum: 1 description: >- Max simultaneous in-flight records from THIS source for people of the SAME company; null = unlimited. Reached for a company => that company's candidates wait. entered_count: type: integer minimum: 0 description: >- [ro] Total workflow_records ever inserted via this source - monotonic on ALL types (cache of the entered_via_source_sid count). blocked_stoplisted_count: type: integer minimum: 0 description: >- [ro] Stoplist entry blocks. view/filter: LIVE backlog gauge, recomputed each poll cycle over current audience members (un-stoplisted people drop out and enter); manual: cumulative per call. blocked_duplicate_in_workflow_count: type: integer minimum: 0 description: >- [ro] Poller-only: candidates skipped as already enrolled in this workflow via ANY source (auto_add never re-enters). view/filter: live gauge per poll cycle; ~0 on manual (add-people re-enters instead). blocked_limit_count: type: integer minimum: 0 description: >- [ro] Candidates WAITING because active_limit / coworkers_limit is reached this cycle; they enter automatically once a slot frees. view/filter: live gauge; manual: cumulative per call. blocked_other_count: type: integer minimum: 0 description: >- [ro] Blocked as deleted/missing/otherwise ineligible people. view/filter: live gauge per poll cycle; manual: cumulative per call. last_evaluated_at: type: string nullable: true description: >- [ro] Last poll cycle (view/filter) or last add-people / inline-create batch (manual); ISO 8601 UTC, null = never evaluated. 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 description: Actor that attached the feed (AccessIdentityValue). deleted_by: type: object nullable: true 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 description: >- Actor that soft-deleted the feed (own verb or workflows.delete cascade); null while live. created_at: type: string description: ISO 8601 UTC. updated_at: type: string description: ISO 8601 UTC. deleted_at: type: string nullable: true description: >- ISO 8601 UTC; null = live (soft delete - the poller gates on it). required: - sid - team_sid - workflow_sid - view_sid - name - type - filter - auto_add - active_limit - coworkers_limit - entered_count - blocked_stoplisted_count - blocked_duplicate_in_workflow_count - blocked_limit_count - blocked_other_count - last_evaluated_at - created_by - deleted_by - created_at - updated_at - deleted_at updated_fields: type: array items: type: string previous_values: type: object additionalProperties: {} kept_fields: type: array items: type: string description: >- The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed. 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 - updated_fields - previous_values - 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.