List campaigns
URL_API_UScampaigns/list
Request
$ curl URL_API_UScampaigns/list?api_key={API_KEY}Toggle Response
{ "success":true, "data":[ { "id":"22222", "account_id":"123", "name":"4x6 Postcard test", "template_id":"0", "type":"4x6-postcard", "trigger_date":null, "send_date":null, "trigger_offset":null, "created":"2019-04-26T10:40:00Z", "updated":"2019-04-26T10:40:00Z", "status":"draft", "recipients_group":"0", "recipients_filter":"", "recipients_validated":"valid", "recipients":"0", "recipients_not_valid":"0", "dispatched":"0", "cost":"0.00", "voucher_code":"", "image":null }, { "id":"221", "account_id":"9", "name":"April Campaign", "template_id":"195", "type":"6x9-postcard", "trigger_date":null, "send_date":null, "trigger_offset":null, "created":"2019-04-26T10:15:40Z", "updated":"2019-04-26T10:15:40Z", "status":"draft", "recipients_group":"0", "recipients_filter":"", "recipients_validated":"valid", "recipients":"0", "recipients_not_valid":"0", "dispatched":"0", "cost":"0.00", "voucher_code":"", "image":"https://dash.stannp.com/api/v1/uploads/9/image-1430044053.jpg" } ] }
Get a single campaign
URL_API_UScampaigns/get/:id
Request
$ curl URL_API_UScampaigns/get/1234?api_key={API_KEY}Toggle Response
{ "success":true, "data":{ "id":"126", "name":"Stannp Test Campaign", "template_id":"111", "type":"4x6-postcard", "trigger_date":null, "send_date":null, "trigger_offset":null, "created":"2019-03-17 11:04:19", "updated":"2019-03-20 10:57:05", "status":"dispatched", "recipients_group":"15", "recipients_filter":"", "recipients_validated":"valid", "recipients":"232", "recipients_not_valid":"0", "updated":"2019-03-21 09:10:05", "cost":"0.00", "voucher_code":"", "image":"https://dash.stannp.com/api/v1/uploads/9/image-1426590259.jpg", "size":"4x6" } }
Create a new campaign
URL_API_UScampaigns/create
Parameters
name | string | Name your campaign for reference. |
type | 4x6-postcard | 6x9-postcard | us-letter | The type of campaign this will be. |
template_id | int | A template ID to make a copy of. If left out or set to "0" then a blank template of the correct format will be used. |
group_id | int | A group id |
what_recipients | all | valid | not_valid | int |
What recipients do you want this campaign to go to? "all" is every recipient in the group "valid" send to only UK / US validated addresses "not_valid" send to only UK / US non validated addresses "int" send to only other international addresses |
code | string | If you have a voucher code. |
Request
$ curl URL_API_UScampaigns/draft?api_key={API_KEY} \ -d "name=My Campaign" \ -d "type=4x6-postcard"Response
{ "success":true, "data":{ "id":"266" } }
Campaign Cost
URL_API_UScampaigns/cost
Parameters
id | int | The id of the campaign to find out the cost of booking |
Request
$ curl URL_API_UScampaigns/cost/?api_key={API_KEY} -d "id=123" \Response
{ "success":true, "data": { "rate": "0.41", "non_valid_rate": "0.51", "delivery_rate": "0.00", "international_rate": "0.00", "valid": "14.35", "not_valid": "191.25", "international": "0.00", "delivery_charge": "0.00", "net": "205.60", "total": "205.60" } }
Approve a campaign
When approving a campaign you take full responsibility for any spelling mistakes or design flaws. Once approved we will select all recipient data at this point and future changes to the same data will not apply to this campaign. This campaign will then be locked so you will be unable to makes changes to the design or recipient selection.URL_API_UScampaigns/approve
Parameters
id | int | The id of the campaign to delete |
Request
$ curl URL_API_UScampaigns/approve?api_key={API_KEY} -d "id=123" \Response
{ "success":true, "data":{} }
Book a campaign
When booking your campaign payment will be taken from your balance.URL_API_UScampaigns/book
Parameters
id | int | The id of the campaign to delete |
send_date | string | The dispatch date of the campaign. Must be in a YYYY-MM-DD format. eg: 2019-12-11 |
use_balance | bool | Set to true to use your balance to pay for the campaign. If you do not pay for the campaign using balance the campaign will be scheduled but will not be posted till payment. |
Request
$ curl URL_API_UScampaigns/book?api_key={API_KEY} -d "id=123" \ -d "send_date=2019-12-11"Response
{ "success":true, "data":{} }
Delete a campaign
URL_API_UScampaigns/delete
Parameters
id | int | The id of the campaign to delete |
Request
$ curl URL_API_UScampaigns/delete?api_key={API_KEY} -d "id=123" \Response
{ "success":true, "data":{} }