Campaign

Manage Business Messenger campaigns. Create or clone a campaign, retrieve campaign lists and details, update campaign data, toggle its active/stopped status, or delete a campaign.

A campaign is defined by a sending_type (sms, whatsapp, email, telegram, rbm, or webpush), a schedule_type that determines when it runs (now, once at a specific date/time, or scheduled per an iCal rrule for recurring sends), and one or more recipient_lists UUIDs identifying the contact lists to target. Instead of targeting a full list, query_type can be set to segmentation to narrow recipients with a segmentation query built from field conditions such as eq, contains, in, or ann_in_days.

New campaigns can also be created by cloning an existing one via clone_uuid, optionally overriding the cloned campaign's text variables through template_vars. A campaign's status can be draft, active, stopped, or finished; the PATCH endpoint toggles it between active and stopped, for example to stop an active campaign before its schedule completes.