POST /campaigns
Create a new campaign targeting a contact book.Authentication
JWT Bearer token (dashboard auth)Request Body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Campaign name |
from | string | Yes | From email address (must be a verified domain) |
subject | string | Yes | Email subject line |
contactBookId | string | Yes | UUID of the target contact book |
previewText | string | No | Preview text shown in email clients |
html | string | No | HTML email content |
text | string | No | Plain text content |
replyTo | string or string[] | No | Reply-to address(es) |
cc | string or string[] | No | CC address(es) |
bcc | string or string[] | No | BCC address(es) |
sendNow | boolean | No | Schedule immediately on creation |
scheduledAt | string | No | ISO 8601 datetime to schedule for |
batchSize | number | No | Emails per batch (1-100000, default 100) |
Response
Example
Errors
| Status | Error | Cause |
|---|---|---|
400 | Invalid request data | Missing required fields |
403 | Campaign limit reached | Free plan allows 1 active campaign |
404 | Contact book not found | Invalid or unauthorized contact book ID |