Campaign Management
Create, schedule, and monitor email marketing campaigns with real-time delivery tracking.
Campaign Workflow
- Create Campaign — Name your campaign and configure basic settings
- Select Template & Lists — Choose an email template and target contact lists
- Configure Settings — Set sender address, subject line, and scheduling options
- Schedule Delivery — Send immediately or schedule for a specific time
- Monitor Performance — Track delivery, opens, clicks, and bounces in real-time
Creating a Campaign
POST /comm-api/api/campaigns
Content-Type: application/json
X-Tenant-Id: your-tenant-uuid
{
"name": "Monthly Newsletter",
"template_id": "uuid",
"list_ids": ["uuid1", "uuid2"],
"motor_block_id": "uuid"
}
Scheduling
POST /comm-api/api/campaigns/{id}/schedule
X-Tenant-Id: your-tenant-uuid
Smart Scheduling Features
- Timezone handling — Schedule campaigns relative to recipient timezones
- Optimal send times — Choose the best time window for your audience
- Rate-limited sending — Chunked delivery maintains sender reputation
Multi-List Targeting
Send to multiple contact lists with automatic deduplication. If a contact appears in multiple selected lists, they receive the campaign only once.
Campaign Analytics
GET /comm-api/api/campaigns/{id}/analytics?days=7
X-Tenant-Id: your-tenant-uuid
Track these metrics per campaign:
| Metric | Description |
|---|---|
| Delivery Rate | Percentage of emails successfully delivered |
| Open Rate | Unique and total email opens |
| Click Rate | Unique and total link clicks |
| Bounce Rate | Hard and soft bounce percentage |
| Unsubscribe Rate | Recipients who opted out |
Campaign States
| State | Description |
|---|---|
draft | Campaign created but not scheduled |
scheduled | Campaign queued for future delivery |
sending | Campaign currently being delivered |
completed | All emails in the campaign have been processed |
paused | Campaign delivery temporarily halted |
cancelled | Campaign cancelled before completion |