Skip to main content
POST
Create campaign

Authorizations

Authorization
string
header
required

Personal Access Token created from Settings -> API Keys.

Body

application/json

A CTA link is required. One-time campaigns also require a goal; lifetime campaigns must be created as drafts and activated with the lifecycle endpoint.

name
string
goal
string
subject
string
html
string
audienceType
enum<string>
default:all
Available options:
all,
tags,
manual,
trigger
audienceTags
string[]
audienceContactIds
string[]
sendNow
boolean
default:false
scheduledAt
string<date-time>
type
enum<string>
Available options:
one-time,
drip,
lifetime
variableManifest
object[]

Lifetime campaigns only. Declares data.* template variables.

generatedVariableManifest
object[]

Lifetime campaigns only. Manifest associated with generated content.

personalizationMode
enum<string>
default:off
Available options:
off,
lead_description_intro

Response

Campaign created

campaign
object