Campaigns
Update Campaign
Update an existing campaign’s settings, content, or scheduling using the AutoSend API.
PATCH
Authorizations
Bearer authentication header of the form Bearer
<token>, where <token> is your auth token.Path Parameters
The id of the campaign to update.
Body
All body fields are optional. Only the fields provided will be updated.Display name of the campaign. Between 1 and 200 characters.
Email subject line. Between 1 and 998 characters.
Preview text shown in email clients. Maximum 200 characters.
Sender identity to use for this campaign.
id of a saved sender identity.
Reply-to email address. Must be a valid email.
ID of the email template to use. 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, triggers sending immediately.ISO 8601 date-time string at which to schedule the campaign for sending.
If
true, send to all contacts in the global list.If
true, publishes and finalizes the campaign.Enable or disable click tracking.
Enable or disable open tracking.
Delivery mode. One of:
immediate, scheduled, gradual.Growth strategy for gradual sending. One of:
fixed, 1.25x, 1.5x, 1.75x, 2x.Number of emails to send per day in gradual mode. Must be at least
1.Timezone string for scheduled or gradual sending.
Response
Returns the updated campaign object.Indicates whether the request was successful.
The updated campaign object.