Skip to main content
POST
Update campaign status
Start or stop a campaign you own. Starting validates channel config (assistant / WhatsApp template / SMS number) and balance. Disabled channels (for example SMS when temporarily unavailable) cannot be started. Starting doesn’t depend on the schedule windows: a campaign started outside them waits for its next window to place calls or send messages. A scheduled campaign starts by itself at its scheduled time and cannot be started here. To start it now, first clear its scheduled_start_at with Update campaign; the campaign goes back to draft.

Request body

integer
required
The ID of the campaign to update
string
required
start or stop

Response

string
default:"Campaign started successfully."
Human-readable outcome
boolean
default:"true"
Whether the operation succeeded
object

Error responses

The campaign could not be started or stopped. success is false and message says why, for example insufficient balance or a stop on a campaign that is not running. Starting a scheduled campaign returns “This campaign is scheduled to start automatically. Clear its scheduled start to start it now.”
The campaign does not exist or does not belong to you.