Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Create and send broadcast, drip, and trigger-based messaging campaigns
GET /api/campaigns
POST /api/campaigns
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Internal label |
type | string | Yes | broadcast, drip, trigger, survey |
templateId | number | Yes | Approved WhatsApp template ID |
audience | string | Yes | all or a contact list ID |
schedule | string | No | immediate, scheduled, or recurring |
scheduledAt | string | No | ISO datetime for scheduled sends |
templateParams | object | No | Dynamic placeholder values |
GET /api/campaigns/:id
POST /api/campaigns/send
| Field | Type | Description |
|---|---|---|
campaignId | number | ID of the campaign to send |
| Status | Description |
|---|---|
draft | Created but not sent |
scheduled | Will send at a future time |
active | Currently running |
paused | Paused mid-run |
completed | Finished sending |
failed | Encountered errors |