Campaigns
Create Campaign
Create a new email marketing campaign with sender, template, recipient lists, and scheduling options via the AutoSend API.
POST
Authorizations
Bearer authentication header of the form Bearer
<token>, where <token> is your auth token.Body
Display name of the campaign. Between 1 and 200 characters.
Email subject line. Between 1 and 998 characters.
Preview text shown in email clients before the message is opened. Maximum 200 characters.
Sender identity to use for this campaign.
id of a saved sender identity. Mutually usable with
from.Reply-to email address. Must be a valid email.
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.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 of list or segment IDs to send the campaign to.
Array of list or segment IDs to exclude from sending.
ID of the unsubscribe group to associate with this campaign.
If
true, the campaign will be scheduled to send after 120 seconds (2 minutes) from creation.ISO 8601 date-time string at which to schedule the campaign for sending.
If
true, the campaign is sent to all contacts in the global list.If
true, publishes and finalizes the campaign.Enable or disable click tracking for this campaign.
Enable or disable open tracking for this campaign.
Delivery mode. One of:
immediate, scheduled, gradual.Growth strategy for gradual sending. One of:
fixed, 1.25x, 1.5x, 1.75x, 2x. Required when sendMode is gradual.Number of emails to send per day in gradual mode. Must be at least
1.Timezone string (e.g.
America/New_York) for scheduled or gradual sending.Mark this campaign as the default campaign. Applies to create only.
Identifies the campaign builder type used to create this campaign. Applies to create only.
Response
Returns the newly created campaign object.Indicates whether the request was successful.
A human-readable message describing the result.
The created campaign object.