campaigns

Set Campaign Play State

Pause, resume or disable an automated campaign for this org.

Pausing stops the planner evaluating it AND the dispatcher holds every queued action for the play (re-checked fresh per action). Stopping disables the play and closes its in-flight wave campaigns, so nothing keeps sending afterwards.

post/campaigns/plays/{play_key}/state

Path parameters

play_keystring required

Request body

action'pause' | 'resume' | 'stop' required

Response

Successful Response

{"stackTrail":"paths:/campaigns/plays/{play_key}/state:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes