HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference
These docs are for a deprecated API version. Click here to use the latest version.

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
Defaults to My new campaign

The campaign name

string
required
Defaults to email

The type of campaign (email or sms, for example)

object
required

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

array of strings
Defaults to Y6nRLr

A list of included audiences

included
array of strings
Defaults to UTd5ui

An optional list of excluded audiences

excluded
object
required

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

string
required
Defaults to static

Describes the shape of the options object. Allowed values: ['static', 'throttled', 'immediate', 'smart_send_time']

object

The send configuration options the campaign will send with. These define variables that alter the send strategy and must match the given method. Intended to be used with the 'static' method.

date-time
required
Defaults to 2022-11-08T00:00:00

The time to send at

boolean

If the campaign should be sent with local recipient timezone send (requires UTC time) or statically sent at the given time. Defaults to False.

boolean

Determines if we should send to local recipient timezone if the given time has passed. Only applicable to local sends. Defaults to False.

object

The send configuration options the campaign will send with. These define variables that alter the send strategy and must match the given method. Intended to be used with the 'throttled' method.

date-time
required

The time to send at

integer
required

The percentage of recipients per hour to send to. Allowed values: [10, 11, 13, 14, 17, 20, 25, 33, 50]

object

The send configuration options the campaign will send with. These define variables that alter the send strategy and must match the given method. Intended to be used with the 'smart_send_time' method.

date
required

The day to send on

object
required

Options to use when sending a campaign

boolean

Use smart sending. Defaults to True

object

The tracking options associated with the campaign

boolean

Whether the campaign is tracking open events. If not specified, uses company defaults.

boolean

Whether the campaign is tracking click events. If not specified, uses company defaults.

boolean

Whether the campaign needs UTM parameters. If set to False, UTM params will not be used.

array of objects

A list of UTM parameters. If an empty list is given and is_add_utm is True, uses company defaults.

utm_params
string
required
Defaults to utm_medium

Name of the UTM param

string
required
Defaults to campaign

Value of the UTM param. Can be templated data.

Headers
string
required
Defaults to 2023-06-15

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

Responses

Language
Credentials