Sign in
Campaigns

Create campaign

Create a new email campaign. Campaigns are created as DRAFT; use POST /campaigns/{id}/send to send or schedule one.

The sender domain must already be verified for this project.

Audience: audienceType decides which companion field is required — SEGMENT requires segmentId, FILTERED requires audienceCondition, and ALL requires neither.

post/campaigns

Request body

namestring required

Campaign name

descriptionstring

Campaign description

subjectstring required

Email subject line

bodystring required

HTML email body

fromstring email required

Sender email address (must be from verified domain)

fromNamestring

Sender name

replyTostring email

Reply-to email address

type'TRANSACTIONAL' | 'MARKETING' | 'HEADLESS'

Content type of the campaign email. Defaults to MARKETING.

audienceType'ALL' | 'SEGMENT' | 'FILTERED' required

Target audience type

segmentIdstring uuid

Segment ID. Required when audienceType is SEGMENT.

Response

Campaign created

successboolean

Changes