blast_repeat

Create, get current parameters for, or delete recurring mass mail campaigns.

Note that these emails typically include new content with each send, sourced from data feeds, can can display personalized content to each user. For more details, see Recurring Campaigns and Use Feeds and Other Content Data in Templates.

Endpoint URL: https://api.sailthru.com/blast_repeat


GET Mode

Get data on a recurring campaign, or all recurring campaigns

Get Recurring Campaign by repeat_id

Example Call:

Copy
{"repeat_id":"12345678"}

Get All Recurring Campaigns Make a call with no parameters:

Copy
{}

Optional Parameters

Parameter Description Example
repeat_id Recurring campaign ID 34463

If you do not pass a repeat_id, you will get a list of all recurring campaigns.

Return Value

Will return a data structure including the following information:
FieldDescriptionExample
repeat_idRecurring campaign ID4d9553239c409dff34000026
nameName of the recurring campaignWeekly Newsletter
listList NameMonday-List
templateName of the template to use
data_feed_urlURL of a data feed to pull prior to sending the blasthttps://example.com/datafeed.json
daysArray containing the days of the week when the campaign will be sent out[Mon, Tue, Wed, Thu, Fri, Sat, Sun]
days_monthArray containing the days of the month when the campaign will be sent out[1, 8, 15, 22]
send_timeThe time when the campaign will be sent out9:00 am
generate_timeThe campaign will generate this many hours prior to sending.3
report_emailThis email will be emailed a copy of the campaign when it generates, and will receive a report when it has finished sending.user@domain.com
start_dateThe date the recurring campaign will take effect05/15/12
end_dateThe date the recurring campaign will no longer send09/15/12

POST to Create or Update Recurring Campaign

Create Recurring Campaign

Example Call:

Copy
{
    "name" : "Weekly Newsletter",
    "list" : "Weekly Newsletter Subscribers",
    "template" : "Recurring Newsletters",
    "template_id" : "5577442",
    "days" : ["Mon"],
    "send_time" : "9:00 a.m. EST",
    "generate_time" : "2",
    "vars" : {
        "banner" : "https://www.example.com/images/weeklybanner.png" 
    },
    "data_feed_url" : "https://example.com/datafeed.json"}

Required Parameters

FieldDescriptionExample
nameName of the recurring campaignWeekly Newsletter
listList NameMonday-List
templateName of the template to use
template_idThe ID number of the template to use5577442
data_feed_urlURL of a data feed to pull prior to sending the blasthttps://example.com/datafeed.json
daysArray containing the days of the week when the campaign will be sent out[Mon, Tue, Wed, Thu, Fri, Sat, Sun]
send_timeThe time when the campaign will be sent out9:00 am
generate_timeA The campaign will generate this many hours prior to sending. At that time, a regular campaign will be generated as an instance of this recurring campaign. The regular can be modified prior to the send time.3
report_emailThis email will be emailed a copy of the campaign when it generates, and will receive a report when it has finished sending.user@domain.com

Optional Parameters

ParameterDescriptionExample
start_dateThe date the recurring campaign will take effect05/15/12
end_dateThe date the recurring campaign will no longer send09/15/12
repeat_idThe ID of an existing recurring campaign. Include this ID if you are updating a recurring campaign, rather than creating a new one.983458

DELETE Mode

Delete a recurring campaign. Campaigns that were already scheduled associated with this repeat will not be removed, but no future campaigns will be scheduled. Required Fields
FieldDescriptionExample
repeat_idRecurring campaign id4d9553239c409dff34000026