GEgetsales
plays

Update play

Rename a play, re-aim its audience, change a find_people play's prompt or cap, pick the workflow of a people play that waits for one (once; fixed after), change the cadence, flip the switch, set the ceiling. enabled true is the consent and makes the play due now (422 on a people play with no workflow yet); enabled false stops the next run and cancels nothing in flight; cadence manual switches it off. The sources are fixed at birth. Nothing changed is 422 nothing_to_update.

Contract:

  • MCP tool update_play, registry package mcp.playtables/plays, mount playtables.pipeline.
  • Operation update, response envelope update.
  • Flags: none.
patch/api/plays/{sid}

Request

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

Path parameters

sidstring required

Play sid (pt_pl_…).

Request body

namestring

New name of the play (1..255).

audienceunknown
mode'ask_me' | 'automatic'

ask_me (the act waits for approval as a task in the Signals feed) | automatic (it goes out by itself).

cadence'manual' | 'daily'

manual switches the play off.

enabledboolean

The switch: true records the consent (enabled_by, enabled_at) and makes the play due now; false stops the next run, nothing in flight is cancelled.

daily_credit_limitinteger nullable

find_people only: the credits one day may spend; null = no ceiling. 422 on an add_to_workflow play.

Response

update success envelope.

successtrue required
operation'update' required
updated_fieldsstring[] required
previous_valuesobject required
kept_fieldsstring[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.

Changes

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