HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Create Campaign

Creates a campaign given a set of parameters, then returns it.

Rate limits:
Burst: 10/s
Steady: 150/m

Scopes:
campaigns:write

Body Params

Creates a campaign from parameters

object
required
string
required
object
required
string
required

The campaign name

object
required

The audiences to be included and/or excluded from the campaign

array of strings
required

A list of included audiences

included*
array of strings

An optional list of excluded audiences

excluded

The send strategy the campaign will send with. Defaults to 'Immediate' send strategy.

string
required
date
required

The day to send on

Options to use when sending a campaign

boolean
Defaults to true

Use smart sending.

The tracking options associated with the campaign

boolean
required
array of objects
required
utm_params*
string
required
string
required
object
required

The message(s) associated with the campaign

array of objects
required
data*
string
required
object
required
object
Headers
string
required
Defaults to 2025-01-15

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses

Language
Credentials