Update a bulk campaign.

Log in to see full request history
Path Params
string
required

ID of the brand to update a campaign in

string
required

ID of the campaign

Body Params
string
required

Name of the campaign

string

Subject line for the campaign

from
object
string

Name of the recipient. Use merge tags to make it more personal and avoid spam filters.

reply_to
object
string
string

Copy shown following your subject line in many email clients.

string

HTML body of the email.

string

Text body of the email.

boolean

True to enable open tracking (HTML campaigns only).

boolean

True to enable click tracking in HTML links.

boolean

True to enable click tracking in text links.

string

ID of a segment used to filter the lists of contacts the campaign is sent to.

string

ID of the message type of the campaign.

list_ids
array of strings

An array of list ids to send the campaign to.

list_ids
excluded_list_ids
array of strings

An array of list ids to exclude from the campaign. Any contacts on these lists will not be sent the campaign.

excluded_list_ids
integer

Time at which to send the campaign. Measured in seconds since the UNIX epoch. Omit to send the campaign immediately.

string

Set to none to send the campaign as fast as possible. Set to burst to send the campaign in small batches over time.

integer
1000 to 1000000

Number of emails to send in each per batch. Must be a multiple of 1000. Required if throttling_type is burst.

integer

Time in seconds between sending each batch of emails. Required if throttling_type is burst.

string

ID of a suppression list. Any emails in the suppression list will not be sent the campaign.

boolean

Set to true to send or schedule the campaign. The campaign will not be sent or scheduled until activated by setting ready to true.

Responses

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json