Pause, resume or automate an X Play
set_x_play_statusPause or resume an X Play, or turn its automatic enrollment on or off, only when the customer asks. Read the Play with list_x_plays first and pass its revision as expectedRevision. Pausing stops future audience collection, not messages already queued in its sequence; use set_sequence_status to stop those too when requested. Resuming, or turning automatic enrollment on (found people go straight into the attached X sequence without review, paced by the daily X budget), may start future outreach. A Play that uses batch review (every Buying intent Play) keeps automatic enrollment off. Never sends directly. Returns the Play after the change.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"playId": "<playId>",
"expectedRevision": "<expectedRevision>"
},
"name": "set_x_play_status"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| playId | Yes | The X Play's ID, from list_x_plays. | |
| status | No | active collects people again; paused stops collecting. Omit to keep the current state. | |
| autopilot | No | true enrolls found people into the attached sequence without review; false sends them to review. Omit to keep the current setting. | |
| workspaceId | No | A teammate's workspace you may manage: an active workspace ID from list_team_workspaces. Omit for your own workspace. Supply on every call for a teammate. | |
| expectedRevision | Yes | The Play's current revision from list_x_plays; a stale revision is refused so a concurrent change is never overwritten. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| play | Yes | The Play after this call. | |
| changed | Yes | Whether this call changed anything. |