Skip to main content
POST

Authorizations

string | header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

string
required
Display name of the campaign. Between 1 and 200 characters.
string
required
Email subject line. Between 1 and 998 characters.
string
Preview text shown in email clients before the message is opened. Maximum 200 characters.
object
Sender identity to use for this campaign.
string
id of a saved sender identity. Mutually usable with from.
string
Reply-to email address. Must be a valid email.
string
ID of the email template to use for this campaign. The template can be created via the Template API. Either templateId or htmlTemplate is required.
string
Raw HTML content to use as the campaign email body. Either htmlTemplate or templateId is required. If both are provided, htmlTemplate takes precedence and the template referenced by templateId will be updated with the provided HTML content.
array
Array of list or segment IDs to send the campaign to.
array
Array of list or segment IDs to exclude from sending.
string
ID of the unsubscribe group to associate with this campaign.
boolean
If true, the campaign will be scheduled to send after 120 seconds (2 minutes) from creation.
string
ISO 8601 date-time string at which to schedule the campaign for sending.
boolean
If true, the campaign is sent to all contacts in the global list.
boolean
If true, publishes and finalizes the campaign.
boolean
Enable or disable click tracking for this campaign.
boolean
Enable or disable open tracking for this campaign.
string
Delivery mode. One of: immediate, scheduled, gradual.
string
Growth strategy for gradual sending. One of: fixed, 1.25x, 1.5x, 1.75x, 2x. Required when sendMode is gradual.
integer
Number of emails to send per day in gradual mode. Must be at least 1.
string
Timezone string (e.g. America/New_York) for scheduled or gradual sending.
boolean
Mark this campaign as the default campaign. Applies to create only.
string
Identifies the campaign builder type used to create this campaign. Applies to create only.

Response

Returns the newly created campaign object.
boolean
Indicates whether the request was successful.
string
A human-readable message describing the result.
object
The created campaign object.