Skip to main content
POST
Create a Campaign

Body

application/json
name
string
required

Name of the campaign; must be unique within the organization

Example:

"Q3 Enterprise Outbound"

template_id
string<uuid>
required

ID of the template enrolled contacts are placed on

Example:

"550e8400-e29b-41d4-a716-446655440000"

audience_ids
string<uuid>[]
required

IDs of the audiences whose contacts are enrolled in this campaign

Minimum array length: 1
Example:
distribution
PercentageDistribution · object
required

Split sends across named senders by fixed percentages that sum to 100.

end_date
string<date> | null

Date the campaign stops enrolling; must not be in the past

Example:

"2026-12-31"

prioritized
boolean
default:false

Whether this campaign takes priority over non-prioritized campaigns

Example:

false

rules_of_engagement
PublicRulesOfEngagement · object | null

Per-rule overrides on the org's default rules of engagement

Example:
autopilot_settings
PublicAutopilotSettings · object | null

Initial autopilot roster. Senders listed here auto-send up to their daily cap; senders in distribution but omitted here require manual approval per send. Omit to leave every sender supervised.

Response

Successful Response

data
CampaignDetailResponse · object
required

Full campaign resource, as returned by get_campaign, create_campaign, and update_campaign.

meta
ResponseMeta · object