Campaigns API

Create, manage, and analyze campaigns.

Endpoints

List Campaigns

GET /api/v1/campaigns

Parameter	Type	Description
type	string	BROADCAST, DRIP, TRIGGERED
status	string	DRAFT, SCHEDULED, SENDING, SENT, FAILED
channel	string	email, sms, whatsapp
page	number	Page number
limit	number	Per page

Create Campaign

POST /api/v1/campaigns

{
  "name": "Welcome Campaign",
  "type": "BROADCAST",
  "channel": "email",
  "subject": "Welcome to our service!",
  "htmlContent": "<h1>Welcome!</h1><p>Thank you for joining.</p>",
  "broadcastListId": "list-uuid",
  "scheduledAt": "2026-03-01T10:00:00Z"
}

Send Campaign

POST /api/v1/campaigns/:id/send

Campaign Statistics

GET /api/v1/campaigns/:id/stats

Response:

{
  "sent": 1500,
  "delivered": 1487,
  "opened": 623,
  "clicked": 198,
  "bounced": 13,
  "deliveryRate": 99.13,
  "openRate": 41.89,
  "clickRate": 31.78
}