Skip to main content

Campaign Management

Create, schedule, and monitor email marketing campaigns with real-time delivery tracking.

Campaign Workflow

  1. Create Campaign — Name your campaign and configure basic settings
  2. Select Template & Lists — Choose an email template and target contact lists
  3. Configure Settings — Set sender address, subject line, and scheduling options
  4. Schedule Delivery — Send immediately or schedule for a specific time
  5. 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:

MetricDescription
Delivery RatePercentage of emails successfully delivered
Open RateUnique and total email opens
Click RateUnique and total link clicks
Bounce RateHard and soft bounce percentage
Unsubscribe RateRecipients who opted out

Campaign States

StateDescription
draftCampaign created but not scheduled
scheduledCampaign queued for future delivery
sendingCampaign currently being delivered
completedAll emails in the campaign have been processed
pausedCampaign delivery temporarily halted
cancelledCampaign cancelled before completion