Skip to main content
POST
Create campaign

Authorizations

Authorization
string
header
required

API Key authentication. Secret keys (sk_*) are required for all endpoints except /v1/track. Public keys (pk_*) only work with the /v1/track endpoint for client-side event tracking. Workspaces can have multiple active keys, and sender-domain operations enforce per-key domain scope when configured.

Body

application/json
name
string
required

Campaign name

subject
string
required

Email subject line

body
string
required

HTML email body

from
string<email>
required

Sender email address (must be from verified domain)

audienceType
enum<string>
required

Target audience type

Available options:
ALL,
SEGMENT,
FILTERED
description
string

Campaign description

fromName
string

Sender name

replyTo
string<email>

Reply-to email address

segmentId
string

Segment ID (required if audienceType is SEGMENT)

audienceCondition
object

Root segment condition structure using logical groups.

Response

201 - application/json

Campaign created

success
boolean
data
object