The campaign area of the email blaster API allows you to effectively view and manage your sent / unsent campaigns. Find out how to quickly preview, clone and manage your setup campaigns.
Campaigns are split into two categories: sent and unsent. A sent campaign is a campaign that has been delivered or scheduled to be delivered to one of your mailing lists. An unsent campaign is a campaign that has been previously created, but has not yet been sent.
Using this API call, you can either return a full listing of your sent or unsent campaigns. To return a listing of your unsent campaigns, construct a GET to the following URL:
Alternatively, to return a listing of your sent / scheduled to be sent campaigns, construct a GET to the following URL:
After a successful request, the following JSON response will be returned:
{
"status":"ok",
"campaigns":[
{
"id":6,
"name":"Bob July Campaign",
"subject":"Our summer newsletter",
"date":"03/08/2020",
"send_volume":"309",
"sent_to":"Customers",
"preview":"https://campaign.emailblaster.cloud/aB/6.html"
},
{
"id":5,
"name":"Bob August Campaign",
"subject":"August is here!",
"date":"12/08/2020",
"send_volume":"4268",
"sent_to":"Subscribers",
"preview":"https://campaign.emailblaster.cloud/aB/5.html"
},
{
"id":4,
"name":"Bob September Campaign",
"subject":"September Newsletter",
"date":"03/09/2020",
"send_volume":"309",
"sent_to":"My Subscribers",
"preview":"https://campaign.emailblaster.cloud/aB/4.html"
},
{
"id":3,
"name":"Bob October Campaign",
"subject":"A spooky newsletter",
"date":"12/10/2020",
"send_volume":"3045",
"sent_to":"My Mailing List",
"preview":"https://campaign.emailblaster.cloud/aB/3.html"
},
{
"id":2,
"name":"Bob November Campaign",
"subject":"It is cold, it is dark!",
"date":"12/12/2020",
"send_volume":"456",
"sent_to":"Mailing List Name",
"preview":"https://campaign.emailblaster.cloud/aB/2.html"
},
{
"id":1,
"name":"Bob December Campaign",
"subject":"It is still cold, it is still dark!",
"date":"20/12/2020",
"send_volume":"0",
"sent_to":"Customer List",
"preview":"https://campaign.emailblaster.cloud/aB/1.html"
}
]
}In both a sent / unsent call, the same field names are returned. The {preview} value contains a unique web link to preview the design / content of your newsletter.
The clone facility is perfect to re-use a previously sent campaign without changing the content. This API section can also be used if you have a set of templates which you wish to use on a regular basis. For each send, a clone API call can be made to create a copy of the desired template.
To perform a clone action, you will need to make a GET request. Your request should be made to the following URL:
After a successful clone request, the following JSON response will be returned:
{
"status":"ok",
"id":"145"
}The campaign search function can be used to return the details of a specific campaign, or set of campaigns against your own search criteria.
In the most basic form, if you know your campaign_id, you can simply submit the campaign_id.
You can also search by campaign name, subject line, date, linked mailing list name or any item of data which will easily distinguish your campaign from your database.
In each case the full campaign details and status will be returned.
To perform a search, you will need to make a POST request. Your request should be made to the following URL:
The request should be a JSON object containing the following information:
{"search_string":"June newsletter"}After a successful request, the following JSON response will be returned:
{
"status":"ok",
"campaigns":[
{
"id":798,
"name":"June newsletter",
"subject":"Our June Newsletter",
"date":"03/06/2017",
"send_volume":"309",
"sent_to":"n/a",
"preview":"https://campaign.emailblaster.cloud/aB/103.html"
},
{
"id":449,
"name":"June newsletter 2",
"subject":"Hot June Deals",
"date":"27/06/2016",
"send_volume":"10345",
"sent_to":"n/a",
"preview":"https://campaign.emailblaster.cloud/aB/104.html"
},
{
"id":779,
"name":"June Newsletter 3",
"subject":"June summer deals",
"date":"12/06/2017",
"send_volume":"3045",
"sent_to":"n/a",
"preview":"https://campaign.emailblaster.cloud/aB/105.html"
},
{
"id":224,
"name":"June Newsletter 4",
"subject":"Welcome to summer",
"date":"12/06/2016",
"send_volume":"1",
"sent_to":"n/a",
"preview":"https://campaign.emailblaster.cloud/aB/106.html"
},
{
"id":444,
"name":"June Newsletter 5",
"subject":"Summer promo",
"date":"22/06/2016",
"send_volume":"",
"sent_to":"n/a",
"preview":"https://campaign.emailblaster.cloud/aB/107.html"
}
]
}
If a campaign is no longer required, you can use the email blaster API to permanently delete this campaign. Deleting a campaign is a one way process and cannot be undone. If you choose to delete a sent campaign, associated analytics data will also be removed.
This call is not suited to cancel a scheduled send. A delete campaign call will simply attempt delete the campaign, not a send. If a future send is setup on the target campaign, the delete request will fail, you will first need to cancel off any attached sends (see send campaign section of API docs).
To run a campaign delete request, this can be done using a DELETE call to the following API URL:
{"status":"ok"}