Campaigns

Create and manage bulk email campaigns with personalization, tracking, and scheduling.

GET/campaigns

List all campaigns with status, pagination.

Query Parameters

ParamTypeDescription
pageintPage number (default: 1)
pageSizeintItems per page (default: 20)
statusstringFilter: draft, scheduled, sending, sent, paused
POST/campaigns

Create a new campaign.

{
  "name": "Q2 Cold Outreach",
  "templateId": "uuid-of-template",
  "smtpAccountId": "uuid-of-smtp-account",
  "mailListId": "uuid-of-mail-list",
  "fromName": "John from Kashew",
  "replyTo": "john@company.com",
  "scheduledAt": "2026-06-01T09:00:00Z"  // optional — sends immediately if omitted
}
GET/campaigns/:id

Get campaign details including stats (sent, opened, clicked, bounced).

POST/campaigns/:id/send

Trigger campaign send. Resolves recipients, creates batches, starts sending.

POST/campaigns/:id/pause

Pause a sending campaign. Can be resumed later.