Skip to main content
PATCH

Authorizations

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

Path Parameters

string
required
The id of the campaign to update.

Body

All body fields are optional. Only the fields provided will be updated.
string
Display name of the campaign. Between 1 and 200 characters.
string
Email subject line. Between 1 and 998 characters.
string
Preview text shown in email clients. Maximum 200 characters.
object
Sender identity to use for this campaign.
string
id of a saved sender identity.
string
Reply-to email address. Must be a valid email.
string
ID of the email template to use. 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, triggers sending immediately.
string
ISO 8601 date-time string at which to schedule the campaign for sending.
boolean
If true, send to all contacts in the global list.
boolean
If true, publishes and finalizes the campaign.
boolean
Enable or disable click tracking.
boolean
Enable or disable open tracking.
string
Delivery mode. One of: immediate, scheduled, gradual.
string
Growth strategy for gradual sending. One of: fixed, 1.25x, 1.5x, 1.75x, 2x.
integer
Number of emails to send per day in gradual mode. Must be at least 1.
string
Timezone string for scheduled or gradual sending.

Response

Returns the updated campaign object.
boolean
Indicates whether the request was successful.
object
The updated campaign object.