Our Campaign Management API lets you create, update , pause and unpause the campaigns accordingly.
Campaigns
A campaign requires a title to be created. In order to send or schedule the campaign, you will be required to provide a campaign name, from name, subject, api key, content (we suggest both html and plain text) and at least one list or segment ID.
1. Create a Campaign
Description: Create a new campaign and add to campaign list.
Url: http://api.easysendy.com/ver1/campaigns
Method: POST
Content-Type: multipart/form-data
Params:
- campaignName- Name of campaign,
- fromName- Name from campaign,
- fromEmail- email from campaign,
- subject- campaign subject,
- segmentUID- segment Uid,
- listUID- list Uid,
- api_key- App API public key,
- content- content file must be in html/zip,
- replyTo- reply to email,
- xmlFeed- feed xml to campaign,
- req_type- create,
- send_at – YYYY-MM-DD hh:mm:ss
Response:
Status(success/errors)
NOTE: –
- xmlFeed should be yes/no (in lower case)
- segmentUID is optional.
- Put date related fields in yyyy-mm-dd
- Date-time related fields in yyyy-mm—dd HH:mm:ss (time in 24 hour format)
2. Update Campaign from List
Description: Update an existing campaign.
Url: http://api.easysendy.com/ver1/campaigns
Method: POST
Content-type: multipart/form-data
Params:
- campaignName- Name of campaign,
- fromName- Name from campaign,
- fromEmail- email from campaign,
- subject- campaign subject,
- segmentUID- segment Uid,
- listUID- list Uid,
- campaignUID-campaign Uid,
- api_key- App API public key,
- content- content file must be in html/zip,
- replyTo- reply to email,
- xmlFeed- feed xml to campaign,
- req_type- update,
- send_at – YYYY-MM-DD hh:mm:ss
Response:
Status(success/errors)
NOTE:
- xmlFeed should be YES/NO.
- segmentUID is optional.
- Put date related fields in yyyy-mm-dd
- Date-time related fields in yyyy-mm—dd HH:mm:ss (time in 24 hour format)
3. Get Campaign Details
Description: Get all the details of any campaign.
Url: http://api.easysendy.com/ver1/campaignAPI2
Method: POST
Content-type: application/x-www-form-urlencoded
Params:
- camp_uid- campaign Uid,
- api_key- App API public key,
- req_type- CAMP_DETAILS
Response:
Status(success/errors)
4. Pause/Unpause Campaign
Description: Pause/unpause any existing campaign.
Url: http://api.easysendy.com/ver1/campaigns
Method: POST
Content-type: application/x-www-form-urlencoded
Params:
- campaignUID-campaign Uid,
- api_key- App API public key,
- req_type- pauseUnpause
Response:
Status(success/errors)
5. Get Total Stats of Single Campaign
Description: Get total stats of single campaign like number of emails sent, bounces,etc.
Url: http://api.easysendy.com/ver1/campaigns
Method: POST
Content-type: application/x-www-form-urlencoded
Params:
- api_key- App API public key,
- req_type- stats,
- campaignUID – your campaign UID
Response:
Status(success/errors)
6. Get Total Stats of All Campaigns
Description: Get total stats of all the campaigns like number of emails sent, bounces,etc. in a range of time period.
Url: http://api.easysendy.com/ver1/campaigns
Method: POST
Content-type: application/x-www-form-urlencoded
Params:
- api_key- App API public key,
- req_type- total_stats,
- from_date – YYYY-MM-DD HH:MM:SS
- to_date – YYYY-MM-DD HH:MM:SS
Response:
Status(success/errors)
Comments