GEgetsales
plays

Create play

Create a play. The usual way: catalog_key alone (plus action.workflow_sid for a people play), which births the playbook's entry on the table as it is, once (a second create answers the existing row); then estimate_play, one sentence with the count and the credits, and run_play or the switch. The other way, a play saved from a view: an audience of one tab (the same filter AST a saved view carries), one action and a cadence. find_people over a company audience: the play owns a find_people source born at the first run; add_to_workflow over a people audience: the play owns a manual source born when the workflow is named (here, or later with update_play). A manual play runs on run_play (the click is the consent); a daily play runs by itself while enabled, and switching it on is the consent: estimate_play first, then say what one run does and what a day may spend (daily_credit_limit) in one sentence, and switch it on only after the yes. Refusals: an action that does not fit the object, a switch or a ceiling where it does not apply, a people play switched on with no workflow (422), an archived workflow (409 conflict), a workflow with no published version (409 invalid_transition), an audience the tab refuses (422 under audience).

Contract:

  • MCP tool create_play, registry package mcp.playtables/plays, mount playtables.pipeline.
  • Operation create, response envelope create.
  • Flags: none.
post/api/plays

Request

  • Base URL
    https://beta.getsales.io/playtables/v1
  • Auth
    HTTP bearer and API key in header Team-SID

Request body

playtable_sidstring required

The table the play lives in; its audience is resolved inside it.

catalog_key'keep_fresh' | 'congratulate' | 'on_job_change' | 'engage_posts' | 'on_website_visit' | 'find_people_empty' | 'top_up_thin' | 'top_up_silent' | 'top_up_no_reply' | 'top_up_exhausted' | 'find_decision_maker' | 'reengage_dormant' | 'reach_untouched'

A playbook play: the entry gives object, audience, action and name, so send only the table (plus action.workflow_sid for a people play; cadence, switch, ceiling if wanted). Born once per table: a repeat answers the existing row, already_exists true.

namestring

Required without catalog_key; with it, a name over the entry's.

object_type'people' | 'company'

Required without catalog_key. What the audience selects: company for find_people, people for add_to_workflow (422 otherwise).

action_type'find_people' | 'add_to_workflow' | 'refresh' | 'congratulate' | 'on_job_change' | 'engage_posts' | 'on_website_visit'

Required without catalog_key.

mode'ask_me' | 'automatic'

ask_me | automatic; absent on a playbook play = the entry's (ask me for the plays that act).

audienceunknown
cadence'manual' | 'daily'

Default manual.

enabledboolean

daily only: true is the consent, stated with the estimate; the first run follows within the minute. 422 on a manual play.

daily_credit_limitinteger nullable

find_people only: what one day may spend. 422 on an add_to_workflow play.

Response

create success envelope.

successtrue required
operation'create' required
already_existsboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.