campaigns
Create and schedule paced bulk WhatsApp deliveries to audiences, then pause, resume, or cancel running sends.
Instructions
Schedule audiences for paced bulk delivery, with pause/resume/cancel controls. Available actions:
list: list campaigns
create: schedule a campaign against an audience (name + audience_id + optional text/media_url/media_caption/on_missing_variable)
get: retrieve a campaign by id
pause / resume / cancel: control a running campaign
Templates: text supports per-contact substitution using SINGLE-brace tokens — Hi {firstName}, your {product} is renewing.
Resolution is case-insensitive. Built-ins always available: {whatsappname}, {displayname}, {phone}, {mobile}.
Custom tokens come from audiences.append_contacts variables (the property name becomes the token).
on_missing_variable=fail (default) rejects at create time if any contact lacks a referenced token; skip accepts and leaves {token} literal in unresolved sends.
Examples:
create: 'campaign called Summer Promo targeting the Leads audience with text "Hi {firstName}, your {product} is renewing"'
pause: 'pause campaign 6a37b9a44919fa7098017a65'
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| skip | No | ||
| text | No | ||
| limit | No | ||
| action | Yes | ||
| media_url | No | ||
| audience_id | No | ||
| campaign_id | No | ||
| media_caption | No | ||
| on_missing_variable | No |