blast_repeat

Welcome to our updated API documentation! (Details here.)
We invite you to rate this page at the bottom or send feedback to docs@sailthru.com.

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.

To get started, use the API Client Library for your preferred language, or learn how to make Sailthru API calls with curl on the API Technical Details page. When using either method, or the API Test tool, you can use this page as a reference for building calls and interpreting responses.


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:

{
 "repeat_id":"12345678"
}

Get All Recurring Campaigns

Make a call with no parameters:

{}

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:

Field Description Example
repeat_id Recurring campaign ID 4d9553239c409dff34000026
name Name of the recurring campaign Weekly Newsletter
list List Name Monday-List
template Name of the template to use
data_feed_url URL of a data feed to pull prior to sending the blast https://example.com/datafeed.json
days Array containing the days of the week when the campaign will be sent out [Mon, Tue, Wed, Thu, Fri, Sat, Sun]
days_month Array containing the days of the month when the campaign will be sent out [1, 8, 15, 22]
send_time The time when the campaign will be sent out 9:00 am
generate_time The campaign will generate this many hours prior to sending. 3
report_email This 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_date The date the recurring campaign will take effect 05/15/12
end_date The date the recurring campaign will no longer send 09/15/12

POST to Create or Update Recurring Campaign

Create Recurring Campaign

Example Call:

{
    "name" : "Weekly Newsletter",
    "list" : "Weekly Newsletter Subscribers",
    "template" : "Recurring Newsletters",
    "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

Field Description Example
name Name of the recurring campaign Weekly Newsletter
list List Name Monday-List
template Name of the template to use
data_feed_url URL of a data feed to pull prior to sending the blast https://example.com/datafeed.json
days Array containing the days of the week when the campaign will be sent out [Mon, Tue, Wed, Thu, Fri, Sat, Sun]
send_time The time when the campaign will be sent out 9:00 am
generate_time A 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_email This 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

Parameter Description Example
start_date The date the recurring campaign will take effect 05/15/12
end_date The date the recurring campaign will no longer send 09/15/12
repeat_id The 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

Field Description Example
repeat_id Recurring campaign id 4d9553239c409dff34000026
Top