Platforms
Action types
Audience types by platform
- For a synced WhatsApp group, set
platform: "whatsapp",audience_type: "group", and pass the group id from Browsers sync aspost_url(and/orgroup_id). - For a CSV or contact list, set
audience_type: "file_upload". Create the campaign first, then upload rows withPOST /api/v1/campaigns/{id}/contacts(or multiparturls_fileafter create). Use aphoneorprofile_urlcolumn for WhatsApp numbers.
audience_keywords and exclude_keywords (default []).
Status and control
You control a campaign lifecycle through thestatus field. There is no separate /pause or /resume endpoint.
Create with
POST /api/v1/campaigns, then set status with PATCH or PUT on /api/v1/campaigns/{id}. Clone with clone_from in the create body.
Daily limit
Thelimit field sets the maximum number of actions per day (default 30).
Schedule
Use theschedule array to restrict when actions are sent:
Messages and placeholders
Message campaigns send one or moremessages entries. Each entry contains a text string array and an optional delay (minutes).
{{first_name}} and any extra CSV column names declared in variables.
Executors
Link connected accounts withexecutor_ids from GET /api/v1/app-states. Use a WhatsApp-connected app-state for WhatsApp campaigns.
WhatsApp group example
WhatsApp CSV / contact list example
- Create a campaign with
audience_type: "file_upload". - Add contacts to that campaign:
member_id (for example 923001234567@c.us) and/or profile_url like https://wa.me/923001234567.
Related endpoints
- Create campaign
- Update campaign
- List campaigns (filter with
platform=whatsapp) - Get campaign
- WhatsApp campaign guide
