Skip to main content
Your broadcasts and calling campaigns, with their results, and the three controls you need while one is running. Campaigns are created and started in the console — the API does not launch them.

Endpoints

kind is whatsapp for a broadcast or voice for a calling campaign; purpose is a calling campaign’s reason for calling.

Pausing, resuming and cancelling

Each answers the campaign as it now is. A campaign in a state the move does not apply to is refused with 409 and says which state it is in — cancelling a campaign that already finished does not pretend it worked.
  • Pause stops further sends. Messages already handed to WhatsApp, and calls already placed, still complete.
  • Resume sends again to everyone not yet reached, charged as usual — so it needs a full-access key.
  • Cancel cannot be undone. Duplicate the campaign in the console to run it again.
A Build key can pause and cancel, since both only stop sending; it cannot resume. See Choose what each key can do.