Create campaign

Create a new campaign draft.

Scopes:
campaigns.write

Body Params

Campaign data

Campaign creation request

abTest
object

A/B test configuration for campaign creation.

audience
object

Campaign audience

boosterSettings
object

Booster settings for campaign creation

string
enum
required

Campaign message channel

Allowed:
content
object

Campaign content for creation

string

Campaign language locale in xx_XX format. Required for regular campaigns (not required for booster or abTest). Must be a supported language

string
length ≤ 250

Campaign name. Required for regular and abTest campaigns (not required for booster)

sendingSettings
object

Sending settings for campaign creation

string
enum
required

Campaign type.

When type is booster, there are two supported flows:

Flow 1 — draft parent + draft booster:
Create a draft parent campaign, then create a draft booster for it
(set boosterSettings.delay to control when it fires). Send the parent;
the booster is scheduled automatically based on the configured delay.

Flow 2 — already-sent parent:
Create and send a parent campaign first. Once it reaches sent status,
create the booster campaign (omit boosterSettings.delay) and use
sendingSettings.scheduledAt to set the exact send time. Then call
the send endpoint on the booster.

Allowed:
Headers
string
required
Defaults to 2026-03-15

API version that specifies the response format and behaviour

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json