blast_repeat

Overview

Get information on, setup, or delete recurring mass mail campaigns.

Also see: Add a Data Feed and Coding a Data Feed into a Template for details of campaign automation.

GET Mode

Get data on a repeating campaign, or all repeating campaigns

Parameter	Description	Example
`repeat_id`	Repeating campaign ID	`34463`

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

Return Value

Will return a data structure including the following information:

Field	Description	Example
`repeat_id`	Repeating campaign id	`4d9553239c409dff34000026`
`name`	Name of the Repeating blast	`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	http://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 repeating campaign will take effect	05/15/12
`end_date`	The date the repeating campaign will stop taking effect	09/15/12

POST Mode

See above for a description.

Required Fields: name, list, template, data_feed_url, days, send_time, generate_time, report_email
Optional Fields: start_date, end_date

If repeat_id is given, existing recurring campaign will be updated.

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`	Repeating campaign id	`4d9553239c409dff34000026`