Emm API Guidev1.3

Email Marketing Management

API Guide

API Version: 1.0

Document Version: 1.2

Last Updated Date: 16th October 2014

1 About netCOREnetCORE is a leader in digital communications space.

The mission of the company is to help clients communicate effectively for marketing and business

needs. We help organizations in the B2C space in acquiring new customers, engaging existing

prospects and customers and in delighting top customers. netCORE has pioneered innovative

technology-based solutions in mailing & mobility domains. Headquartered in Mumbai, and

operating from 8 other locations, netCORE has a pan-India presence.

netCORE has a suite of products and services for digital marketing. It proudly stands at the no.1

position in email marketing and ranks in the top 3 in SMS services in India. Its Email Marketing suite

offers access to a scalable technology platform. Mobile marketing solutions range from group SMS

based solutions, mobile coupons, sms competitions and polls, integration to back-end systems like

ERP, CRM or Loyalty solutions as well as voice solutions on IVR, toll free numbers, missed calls or

short codes and long codes for receiving incoming messages.

Its platform also includes a multi-modal response management solution that helps keep track of

campaign responses across products. Marketing solutions and services are coupled with an

experienced solution selling team that helps ideate on usage of the medium to get the most

effective communication.

Its messaging products are one-stop solutions to build the back-end infrastructure in large

enterprises as well as small & medium-sized businesses. From Email to VPN, firewall to bandwidth

management, virus protection to Spam filtering, netCORE covers it all!

netCORE has an impressive client base of more than 1500 corporates. Its key clients include ICICI

Bank, FutureGroup, BajajAllianz, HUL, Colgate, JustDial, TimesNow, Reliance, to name a few.

2 Table of Contents

About netCORE...................................................................................................................................1

1About the document.........................................................................................................................1

1.1Intended Audience.........................................................................................................................1

1.2Organization of the document.......................................................................................................1

1.Overview of Email Marketing Management......................................................................................2

2.1 EMM API........................................................................................................................................2

2.2 Why Use the API?..........................................................................................................................2

2.3 Not a Programmer?.......................................................................................................................2

2.Get Started with the EMM API..........................................................................................................2

3.1 Module..........................................................................................................................................3

3.2 Action............................................................................................................................................3

3.3 Data..............................................................................................................................................3

3.4 Syntax for API requests.................................................................................................................3

3.EMM API library................................................................................................................................3

4.1 Campaign......................................................................................................................................3

4.1.1 Query.........................................................................................................................................3

4.1.2 Add.............................................................................................................................................4

4.1.3 Quicktest....................................................................................................................................4

4.1.4 Copy...........................................................................................................................................5

4.1.5 Schedule....................................................................................................................................5

4.1.6 Suspend.....................................................................................................................................5

4.1.7 Requeue....................................................................................................................................6

4.1.8 Trigger .......................................................................................................................................6

4.2 Attribute........................................................................................................................................6

4.2.1 Add.............................................................................................................................................6

4.3.1Query..........................................................................................................................................7

4.3.2Update........................................................................................................................................7

4.3.3Download....................................................................................................................................8

4.3.4Delete.........................................................................................................................................8

4.3 List................................................................................................................................................9

4.3.1 Add.............................................................................................................................................9

4.3.2 Update.......................................................................................................................................9

4.3.3 Delete......................................................................................................................................10

4.3.4 ListSummary............................................................................................................................10

4.3.5 DataUpload..............................................................................................................................10

4.3.6 MostActive...............................................................................................................................11

4.3.7 BatchUpload.............................................................................................................................11

4.3.8 ListData....................................................................................................................................12

4.4 Contact........................................................................................................................................12

4.4.1 Add...........................................................................................................................................13

4.4.2 Query.......................................................................................................................................13

4.4.3 QueryStats...............................................................................................................................13

4.4.4 Update.....................................................................................................................................14

4.4.5 Delete......................................................................................................................................15

4.5 Report.........................................................................................................................................15

4.5.1 Summary..................................................................................................................................15

4.5.2 Download.................................................................................................................................16

4.5.3 Daywise....................................................................................................................................17

4.6 Jobs.............................................................................................................................................18

4.6.1 Status.......................................................................................................................................18

4.6.2 Update.....................................................................................................................................18

4.6.3 Delete.....................................................................................................................................19

1 About the documentThe Email Marketing Management API Guide Version 1.2 describes the Application Programming

Interfaces that EMM campaign platform provides.

2.1 Intended AudienceThis document is intended for those who wish to integrate their existing software systems with the

EMM platform through API.

2.2 Organization of the documentThe sections in the document are as follows:

Overview of Email Marketing Management gives a basic overview of the Email Marketing

Management (EMM) application it’s APIs.

Get Started with the EMM API explains how to get started with using the EMM APIs.

EMM API library explains the APIs available in each module of EMM.

1. Overview of Email Marketing Management

Netcore hosted email marketing platform, Email Marketing Management

(EMM) allows permission based marketers to manage, send, track and

grow their email marketing investment.

Companies across all industries & verticals are devoting considerable

amount of their time, resources, and budgets to email marketing. Email

typically costs less than other direct marketing channels and the return

exceeds all other initiatives. It helps organizations stay in constant touch

with their customers at a very minimal investment.

To achieve the highest return on investment, email marketers must get

savvy and revise their strategies. Sending emails in bulk without designed

and customized as per the customers, is not very useful. For example,

instead of sending monthly email newsletters to the entire customer base,

sending weekly mails withrelevant information to targeted subscribers can

result in better customer response.

Targeted emails nearly double the click-through rates of bulk emails. So, it

is required to use advanced tactics like dynamic profiling and dynamic

content to segment your lists.

2.3 2.1 EMM APIThe EMM API library provides you all the tools to manage your lists and access campaign statistics.

You can connect to our API using XML–RPC, a simple HTTP POST, or HTTP GET and receive the

output in XML format.

2.4 2.2 Why Use the API?If you sync your customer database into EMM, you do not have to constantly import your updated

lists into EMM, export them again into your system, then manually clean up any differences. The

database is automatically in synced. You can also sync your campaign statistics.

Here are some other ways to use the API:

Synchronize data with CRM systems and databases: Instead of manually uploading files,

automatically exchange information. For example, simultaneously move data from Web signup

forms to both your CRM system and EMM.

Create and send messages: Populate your email template with Web page content, send

yourself a test email and schedule your campaign for delivery – without lifting a finger.

Implement private label client portals: Create privatelabel client portals, where agencies

and resellers can log in and grab campaign stats.

Online Subscription forms: Add a “Subscribe to Newsletter” option to your ecommerce

checkout page.

Targeted Campaign: Pass purchasehistory data into EMM, create list segments, and send

targeted campaigns.

Publishers’ data sync: Sync active subscription data into EMM, so that only uptodate

accounts get your emails. Sync email activity with your customer database

Behavioural Targeting: Link campaign stats to your internal database for behavioural

targeting.

Connect EMM to a CMS, blog platform, ecommerce shopping cart, and more.

2.5 2.3 Not a Programmer?The API is for programmers only. If you’re not a programmer, and there’s not one in your company

to bribe, you can contact our Experts.

2. Get Started with the EMM APIThe EMM API is based on REST architecture style. In these APIs, you need to initiate password

authenticated XML calls over HTTPS.

The procedure to use API is as mentioned below:

1 Enable API access in EMM’s panel.

1. Submit a request via HTTPS POST to EMM. For best results, use HTTPS POST.

2. Submit a call for each function.

You cannot combine multiple calls into a single call.

mailto:[email protected]

Each API request must include the following fields:

1. Module

2. Action

3. Data

These fields are case sensitive. Values for fields vary according to the type of request.

2.6 3.1 ModuleEMM application comprises the following modules:

1. Campaign

2. Attributes

3. List

4. Contact

5. Report

6. Jobs

NOTE: In the API call, specify the module in the type field.

2.7 3.2 ActionEach module has various actions associated to it. A few generic actions are:

add

delete

update

upload

download

NOTE: In your API call, specify the action in the activity field.

2.8 3.3 DataData comprises the constant and the input:

Constant: is the API key. You can obtain the API key from the EMM panel.

Input: comprises the raw parameters like listname, subject, from, and so on.

The input must be URL coded. In the API call, the data is specified as shown below:

2.9 3.4 Syntax for API requests

data=<DATASET>

<CONSTANT><ApiKey>[api key]</ApiKey></CONSTANT>

<INPUT>[input parameters]</INPUT>

</DATASET>

The following is the syntax for making EMM API requests:

https://api.exacttouch.com/API/mailing/?

type=[module]&

activity=[action]&

data=<DATASET>

<CONSTANT><ApiKey>[apikey]</ApiKey></CONSTANT>

<INPUT>[input parameters]</INPUT>

</DATASET>

For example, the following API shows how to make an API request to create a campaign from the

Campaign module.

https://api.exacttouch.com/API/mailing/ ?

type=message&activity=Add&

data=<DATASET>

<CONSTANT>

<ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>

</CONSTANT>

<INPUT>

<Subject>NewCampaign</

Subject><FromName>[email protected]</

FromName><FromEmail>[email protected]</FromEmail><DYNAMIC></

DYNAMIC><ReplyTo>[email protected]</

ReplyTo><TemplateID>1</TemplateID><SetLimit>4</

SetLimit><MessageHTML><![CDATA[Hello,

This is the first email.

Thanks ]]></MessageHTML><MessageMobile>

https://api.exacttouch.com/API/mailing/?type=message&activity=Add&data

https://api.exacttouch.com/API/mailing/?type=message&activity=Add&

https://api.exacttouch.com/API/mailing/?type=message&activity=Add&

https://api.exacttouch.com/API/mailing/


<![CDATA[]]></MessageMobile><Attcount>1</Attcount>

</INPUT>

</DATASET>

3. EMM API libraryThe APIs available in the modules of EMM are listed in the sections below.

2.10 4.1 CampaignCampaign is the email content sent to your customer database.

The following activities associated with campaign, can be performed using the API listed in this

section:

1 Query: to view and update a campaign.

1. Add: to create a campaign.

2. Quickest: to send test campaigns to any email address.

3. Copy: to copy a campaign.

4. Schedule: to schedule and re queue a campaign.

5. Suspend: to suspend an in progress campaign.

6. Requeue: to re queue the delivery of a specified campaign.

7. Trigger: to trigger campaigns to provided email address.

4.1.1 Query

You can use this activity to retrieve data related to a specific campaign.

[type] : message

[activity] : Query

Input parameters:

1. Campaign ID [Required]: is the id of the campaign that you want to query.

Input XML

Output XML

<DATASET>

<CONSTANT><ApiKey>[Value]</ApiKey>

</CONSTANT>

<INPUT><MID>[value]</MID></INPUT>

</DATASET>

Sample API call:

<DATASET>

<TYPE>[value]</TYPE>

<OUTPUT><MID>[value]</MID></OUTPUT>

</DATASET>

Input XML:


type=message&activity=Query&

data=<DATASET>

<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>

</CONSTANT>

<INPUT><MID> 1 </MID></INPUT>

</DATASET>

Output XML:

<DATASET>

<TYPE>success</TYPE>

<OUTPUT><MID>1</MID></OUTPUT>

</DATASET>

4.1.2 Add

You can use this activity to add a campaign to a mailing list.

[type] : message

[activity] : Add

Input Parameters:


1. FromEmail [Required]: The email address to be displayed in the From/Sender field.

2. FromName [Required]: The name to be displayed in the From field.

3. ReplyTo [Optional]: The email address to be displayed in the Reply-To field.

4. MessageHTML [Required for HTML Campaigns]: The content of the HTML version of the email

that you want to send to your customers.

5. MessageMobile [Optional]: The content of the Mobile version of the campaign that you

want to send to your customers.

6. TemplateID [Optional]: ID of the template to be used for sending the campaign.

7. Attachment [I] [Optional]: The HTTP URL or FTP location of the file to be attached. You can

attach multiple files.

Here, [I] starts from 1.

Example for FTP attachment: ftp://qa:q@#[email protected]/20140810.xls

Example for HTTP attachment: http://emm16.legacymails.com/test.csv

8. SetLimit [Optional]: The number of users to which you want to send the campaign.

NOTE:

The size of the attachment must not exceed the maximum permissible size as specified in EMM.

The names of the attached files must be unique. Uploading files with duplicate names may result in overwriting.

Input XML:

<DATASET>

<CONSTANT><ApiKey>[value]</ApiKey></CONSTANT>

<INPUT><Subject>[value]</Subject>

<FromName>[value]</FromName>

<FromEmail>[value]</FromEmail>

<DYNAMIC>[value]</DYNAMIC>

<ReplyTo>[value]</ReplyTo>

<TemplateID>[value]</TemplateID>

<SetLimit>[value]</SetLimit>

<MessageHTML>[value]</MessageHTML>

<MessageMobile>[value]</MessageMobile>

<Attachment0>[value]</Attachment0>

<Attachment1>[value]</Attachment1>

<Attcount>[value]</Attcount></INPUT></DATASET>

Output XML:

<DATASET>



</DATASET>

Sample API call:

Input XML:



type=message&activity=Add&

data=<DATASET>

<CONSTANT>


</CONSTANT>

<INPUT><Subject>monthly newsletter</Subject>

<FromName>customersupport</FromName>

<FromEmail>[email protected] </FromEmail><DYNAMIC></

DYNAMIC><ReplyTo></ReplyTo><TemplateID> 1 </

TemplateID><SetLimit> 4 </SetLimit><MessageHTML><!

[CDATA[ hello ]]></MessageHTML><MessageMobile><![CDATA[]]></

MessageMobile>

<Attcount>1</Attcount>

</INPUT></DATASET>

Output XML:

<DATASET>


<OUTPUT><MID>3</MID></OUTPUT>

</DATASET>

4.1.3 Quicktest

You can use this activity to send tests to any email address. You can send multiple campaigns with

dynamic data to the specified email addresses. The activity returns success and failure status of

email-address used to test campaign.

[type] : message

[activity]: Quicktest

Input Parameters:

1. MID [Required]: The campaign ID. You can provide multiple ids in comma separated format.

2. Emails [Required]: The address to which the test is to be sent. You can provide multiple ids in

comma separated format.

NOTE: You need to add the test email id to the contacts in EMM before you send a test email to it.

mailto:[email protected]%3C/FromEmail%3E%3CDYNAMIC%3E%3C/DYNAMIC%3E%3CReplyTo%3E%3C/ReplyTo%3E%3CTemplateID%3E1%3C/TemplateID%3E%3CSetLimit%3E4%3C/SetLimit%3E%3CMessageHTML%3E%3C!%5BCDATA%5Bhello%5D%5D%3E%3C/MessageHTML%3E%3CMessageMobile%3E%3C!%5BCDATA%5B%5D%5D%3E%3C/MessageMobile



Input XML

Output XML

<DATASET>


<INPUT><MID>[value]</MID>

<Emails>[value]</Emails></INPUT>

</DATASET>

<DATASET>


<OUTPUT>

<EmailSuccess>[value]</EmailSuccess>

<EmailFailure>[value]</EmailFailure>

<MID>[value]</MID>

</OUTPUT>

</DATASET>

Sample API Call:

Input XML:


type=message&activity=Quicktest&

data=<DATASET>


</CONSTANT>


<INPUT><MID>11</MID><Emails>[email protected]

</Emails></INPUT>

</DATASET>

Output XML:

<DATASET>


<OUTPUT>

<EmailSuccess>[email protected]</EmailSuccess>

<EmailFailure></EmailFailure>

<MID>3</MID>

</OUTPUT>

</DATASET>

4.1.4 Copy

You can use this activity to copy a campaign to a mailing list. Copying a campaign creates a copy

of an existing campaign with the email content, contact list, and so on. The campaign is saved with

a new campaign id.

[type] : message

[activity] : Copy

Input Parameters:

1. MID [Required]: ID of the campaign you want to copy.

Input XML

Output XML

<DATASET>



</DATASET>

S ample API Call:

<DATASET>



</DATASET>

Input XML:


type=message&activity=Copy&

data=<DATASET>


</CONSTANT>

<INPUT><MID>12</MID></INPUT></DATASET>

Output XML:

<DATASET><TYPE>success</TYPE>

<OUTPUT><MID>3</MID></OUTPUT></DATASET>

4.1.5 Schedule

You can use this activity to schedule, re queue or resume the delivery of an existing campaign.

NOTE: To send the campaign immediately, specify schedule for the action parameter only. You do

not have to specify the Delivery‐Year, Delivery‐Month, Delivery‐Day, and Delivery‐Hour parameters.

[type] : message

[activity]: Schedule

Input Parameters

1. MID [Required]: The ID of the campaign you want to submit.

2. List ID [Required]: The ID of the group to which you want to send the campaign.

3. DeliveryYear, DeliveryMonth , DeliveryDate, DeliveryHour,

DeliveryMinute: All these fields are optional and you need to specify the values only if you

want to schedule the campaign for a later point of time. The current time and date are the default value of these fields.

Input XML


<DATASET>

<CONSTANT>

<ApiKey>[value]</ApiKey></CONSTANT>

<INPUT><MID>[value]</MID>

<DeliveryYear>[value]</DeliveryYear>

<DeliveryMonth>[value]</DeliveryMonth>

<DeliveryDate>[value]</DeliveryDate>

<DeliveryHour>[value]</DeliveryHour>

<DeliveryMinute>[value]</DeliveryMinute>

<LID>[value]</LID></INPUT>

</DATASET>

Output XML

Sample API Call:

<DATASET>


<OUTPUT>

<MID>[value]</MID>

</OUTPUT>

</DATASET>

Input XML:


type=message&activity=Schedule&

data=<DATASET>


</CONSTANT>


<INPUT><MID>12</MID><DeliveryYear>2014</

DeliveryYear><DeliveryMonth>11</

DeliveryMonth><DeliveryDate>25</

DeliveryDate><DeliveryHour>12</

DeliveryHour><DeliveryMinute>00</DeliveryMinute>

<LID>10</LID>

</INPUT></DATASET>

Output XML:



NOTE: The selection of target List ID for a specific campaign gets replaced with every API call.

For example, for campaign ID 1, List ID Selected are12, 24, 25.

If campaign is scheduled with list ID 32, 35 then above saved list Id's (12, 24, 25) are replaced with different ids.

4.1.6 Suspend

You can use this activity to suspend the delivery of a specified campaign. You can suspend only

those campaigns which are in in-process or queued state.

[type]: message

[activity]: Suspend

Input Parameters:

1. MID [Required]: The ID of the campaign you want to suspend.

Input XML

Output XML

<DATASET>



</DATASET>

<DATASET>



</DATASET>

Sample API Call:

Input XML:


type=message&activity=Suspend&

data=<DATASET>


</CONSTANT>

<INPUT><MID>10</MID></INPUT>

</DATASET>

Output XML:



4.1.7 Requeue

You can use this activity to re-queue the delivery of a specified campaign. You can re-queue only

those campaigns that are in suspended or sent state. Also, the campaigns are not sent to the

contacts who have already received the campaign.

[type]: message

[activity] : Requeue

Input Parameters:

1. MID [Required]: The ID of the message you want to re-queue.


Input XML:

<DATASET>


<INPUT><MID>[value]</MID></INPUT></DATASET>

Output XML

S ample API Call:

<DATASET>


<OUTPUT><MID>[MID] re queued successfully</MID></OUTPUT>

</DATASET>

Input XML:


type=message&activity=Requeue&

data=<DATASET>


</CONSTANT>

<INPUT><MID>12</MID></INPUT>

</DATASET>

Output XML:

<DATASET>


<OUTPUT><MID>3 re queued successfully</MID></OUTPUT>

</DATASET>


4.1.8 Trigger

You can use this activity to trigger campaigns to provided email address. For sending trigger

campaigns, campaign need to be previously designed. Campaign can be designed using EMM API

or EMM panel.

[type]: message

[activity] : Trigger

Input Parameters:

1. AddEmail[Required]: The email address to which campaign is to be triggered.

2. ID[Optional]: Attribute ID that needs to be updated for the required users.

3. Value[Optional]: Attribute value to be used for specified attribute.

4. TriggerEmail [Required]: Message ID of the campaign to be triggered. You can trigger one

campaign at a time.

Input XML

<DATASET>


<INPUT>

<AddEmail>[value]</AddEmail>

<ForeignKey>[value]</ForeignKey>

<CcEmail>[value]</CcEmail>

<AttributeValues>

<RECORD>

<ID>[value]</ID>

<[value]>[value]</[value]>

</RECORD>

</AttributeValues>

<TriggerEmail>[value]</TriggerEmail>

</INPUT>

</DATASET>

Output XML

Sample API Call:

<DATASET>


<OUTPUT><MID>[MID] triggered successfully</MID></OUTPUT>

</DATASET>

Input XML:


type=message&activity=Trigger&

data=<DATASET>


</CONSTANT>

<INPUT><AddEmail>[email protected] </AddEmail><ForeignKey> 12 </

ForeignKey><CcEmail> [email protected] </

CcEmail><AttributeValues> 12 </

AttributeValues><TriggerEmail> 13 </TriggerEmail >

</INPUT>

</DATASET>

Output XML:

<DATASET>


<OUTPUT><MID>3 triggered successfully</MID></OUTPUT>

</DATASET>

mailto:[email protected]%3C/AddEmail%3E%3CForeignKey%3E12%3C/ForeignKey%3E%3CCcEmail%[email protected]%3C/CcEmail%3E%3CAttributeValues%3E12%3C/AttributeValues%3E%3CTriggerEmail%3E13%3C/TriggerEmail




2.11 4.2 AttributeAttributes are the properties of the contacts present in your lists. Email id, gender, age, location,

and so on are the attributes. All the attributes can be categorised into four types:

a. Text: For defining names, email ids, addresses and so on. This type can comprise alphabets, numbers, and special characters. For example, Delhi_12 57@#5, Priy@nka_12.

b. Date: for defining date of birth, date of purchase, and so on. The dates must be in the DD-MM-YYY or YYYY-MM-DD format. For example, 23-01-2013 or 2012-01-23.

c. Integer: For defining attributes like age. You can provide only numerical values. For example, 25, 35. 25 years is and invalid format.

d. Decimal: For defining attributes like salary. The format can be comprise numbers and decimal point. For example, 35.5, 4.5. 3.5 lakhs is an invalid format.

You can do the following activities associated with attributes, with the APIs listed in this section:

1 Add: to add an attribute.

1. Query: to retrieve information of an attribute.

2. Update: to update an attribute.

3. Download: to download the attributes details.

4. Delete: to delete attributes.

4.2.1 Add

You can use this activity to add an attribute.

[type] : attribute

[activity] : Add

Input parameters:

1. Attname [Required]: Name of the attribute you want to create.

2. Atttype: Type of the attribute you want to add. For more details, please see attribute types.

3. Defaultval: Default value to be used for the specified attribute.

Input XML

Output XML

<DATASET>

<CONSTANT><ApiKey>[Value]</ApiKey></CONSTANT>

<INPUT>

<Attname>[Value]</Attname>

<Atttype>[Value]</Atttype>

<Defaultval>[Value]</Defaultval>

</INPUT></DATASET>

<DATASET>

<TYPE>[value]</TYPE><OUTPUT>

<Attid>[Value]</Attid>

<Atttype>[Value]</Atttype></OUTPUT></DATASET>

Sample API Call:

4.3.1 Query

Input XML:


type=attribute&activity=Add&


data=<DATASET>


</CONSTANT>

<INPUT><Attname>username</Attname><Atttype>textline</

Atttype><Defaultval>admin</Defaultval></INPUT>

</DATASET>

Output XML:

<DATASET> <TYPE>success</TYPE><OUTPUT>

<Attid>4</Attid>

<Atttype>textline</Atttype></OUTPUT></DATASET>

You can use this activity to retrieve information about an attribute.

[type] : attribute

[activity] : Query

Input parameters:

1. Attid [Required]: Id of the attribute for which details are required. You can specify only one

attribute at a time.

Input XML

Output XML

<DATASET>


<INPUT><Attid>[Value]</Attid></INPUT>

</DATASET>

<DATASET>


<OUTPUT>




<Defaultval>[Value]</Defaultval>

</OUTPUT>

</DATASET>

Sample API Call:

4.3.2 Update

Input XML:


type=attribute&activity=Query&

data=<DATASET>


</CONSTANT><INPUT><Attid>3</Attid></INPUT></DATASET>

Output XML:


<DATASET>


<OUTPUT><Attid>4</Attid>

<Attname>Name</Attname>

<Atttype>textline</Atttype>

<Defaultval>admin</Defaultval>

</OUTPUT>

</DATASET>

You can use this activity to update the information of an attribute.

[type] : attribute

[activity] : Update

Input Parameters:

1. Attid [Required]: Attribute ID which is to be updated.

2. Attname [Required]: Name to be used as attribute.

3. Atttype: Type of the attribute. To know about attribute types, please see this.

4. Defaultval: Default value to be used for the specified attribute.

Input XML

Output XML

<DATASET>


<INPUT>




<Defaultval>[Value]</Defaultval></INPUT>

</DATASET>

<DATASET>


<OUTPUT>



</OUTPUT>

</DATASET>

Sample API Call:

4.3.3 Download


type=attribute&activity=Update&

data=<DATASET>


</CONSTANT><INPUT><Attid>7</Attid>

<Attname>username</Attname>

<Atttype>textline</Atttype>

<Defaultval>admin</Defaultval></INPUT></DATASET>

You can use this activity to download the information of an attribute.

[type]: attribute

[activity]: Download


Input Parameters:

1. Attid: Id of the attribute which you want to delete. You can specify multiple attributes in

comma separated format. If do not specify ids, all the attributes are downloaded.

Input XML

<DATASET>


<INPUT><Attid>[value]</Attid></INPUT></DATASET>

Output XML

<DATASET>


<OUTPUT>

<RECORD>

<Attid>[value]</Attid>

<Name>[value]</Name>

<Type>[value]</Type>

<DefaultValue>[value]</DefaultValue>

<Required>[value]</Required>

</RECORD>

</OUTPUT>

</DATASET>

Sample API Call:

Note: If multiple attribute Id's are specified, multiple record XML nodes are returned as output.

Input XML:


type=attribute&activity=Download&data=

<DATASET><CONSTANT>

<ApiKey>abcde123fghijk456lmno789pqrst</ApiKey></CONSTANT>

<INPUT><Attid>7</Attid></INPUT>

</DATASET>

Output XML:

<DATASET><TYPE>[value]</TYPE><OUTPUT>

<RECORD><Attid>[value]</Attid>


<Type>[value]</Type>

<DefaultValue>[value]</DefaultValue>

<Required>[value]</Required>

</RECORD></OUTPUT></DATASET>


4.3.4 Delete

You can use this activity to delete the information of an attribute.

[type] : attribute

[activity] : Delete

Input parameters:

1. Attid [Required]: Id of the attribute which you want to delete. You can delete only one

attribute at a time.

Input XML

Output XML

<DATASET>

<CONSTANT>

<ApiKey>[Value]</ApiKey>

</CONSTANT>

<INPUT><Attid>[Value]</Attid></INPUT>

</DATASET>

<DATASET>


<OUTPUT>

<Attid>[value]</Attid>

</OUTPUT>

</DATASET>

Sample API Call:

2.12 4.3 List

Input XML:


type=attribute&activity=Delete&

data=<DATASET>


</CONSTANT>

<INPUT><Attid>5</Attid></INPUT>

</DATASET>

Output XML:

<DATASET><TYPE>success</TYPE><OUTPUT>

<Attid>4</Attid></OUTPUT></DATASET>

List is the list of email addresses of your customer database. Lists are of two types:

a. Active: lists appear in the unsubscribe page. In the API, the value for Active lists is 1.

b. Inactive: lists do not appear in the unsubscribe page. In the API, the value for inactive lists is 0.

Email campaigns can be sent to active as well as inactive lists.

The following activities associated with Lists can be performed using the API listed in this section:

1 Add: to create a list.

1. Update: to edit the list properties.

2. Delete: to delete a list.

3. ListSummary: to retrieve the details of the list.

4. DataUpload: to upload data using a csv file.

5. BatchUpload: to add email-addresses to a list in batches.


6. MostActive: to retrieve the list of most active users. Most active users are those who have been

the most active in a list or in the entire database of users.

7. ListData: List of users, that is, Confirmed, Unconfirmed, Blacklisted and Deleted users. To know

more about users, please see types of users.

4.3.1 Add

You can use this activity to create a mailing list. The response returns the unique list id of the new

list.

[type] : list

[activity] : Add

Input parameters:

1. Name [Required]: Name of the list that you want to create.

2. Description [Optional]: Brief description of the list.

3. Active [Optional]: Status of the list to be created, active or inactive.

Input XML

Output XML

<DATASET>


<INPUT>


<Description>[value]</Description>

<Active>[value]</Active>

</INPUT>

</DATASET>

<DATASET>


<OUTPUT><LID>[value]</LID></OUTPUT>

</DATASET>

Sample API call:

Input XML:


type=list&activity=Add&

data=<DATASET>

<CONSTANT>


</CONSTANT>

<INPUT><Name>regular buyers group</Name><Description>monthly

offers </Description><Active>1</Active></INPUT>

</DATASET>

Output XML:

<DATASET>


<OUTPUT><LID>5</LID></OUTPUT>

</DATASET>

4.3.2 Update

You can use this activity to edit a mailing list. The response returns success and failure notification

with the unique list id.

[type] : list

[activity] : Query

Input parameters:

1. Name [Required]: Name of the list that you want to create.

2. Description [Optional]: Brief description of the list to be created.

3. Active [Optional]: Status of the list to be created, whether active or inactive.

4. LID [Required]: ID of the list you want to update.

Input XML

Output XML


<DATASET>


<INPUT>

<LID>[value]</LID>


<Description>[value]</Description>


</INPUT>

</DATASET>

<DATASET>


<OUTPUT><LID>[value]</LID></OUTPUT>

</DATASET>

Sample API call:


type=list&activity=Query&

data=<DATASET>



</CONSTANT>

<INPUT><LID>21</LID></INPUT>

</DATASET>

4.3.3 Delete

You can use this activity to delete a mailing list. The response returns success or failure notification

with the unique list id.

[type] : list

[activity] : Delete

Input parameters:

1. LID [Required]: Id's of the list which you want to delete. You can provide multiple ids in comma

separated format.

Input XML

Output XML

<DATASET>


<INPUT><LID>[value]</LID></INPUT>

</DATASET>

<DATASET><TYPE>[value]</TYPE>

<OUTPUT><LID>[value]</LID></OUTPUT></DATASET>

Sample API call:

Input XML:


type=list&activity=Delete&

data=<DATASET>


</CONSTANT><INPUT><LID>5</LID></INPUT>


</DATASET>

Output XML:

<DATASET>


<OUTPUT><LID>23</LID></OUTPUT>

</DATASET>

4.3.4 ListSummary

You can use this activity to get information about all the existing lists.

[type] : list

[activity] : ListSummary

Input parameters:

1. LID [Required]: ID of the list of which you want to view the details. Separate multiple list Id's by

comma.

2. Active [Optional]: Type of lists you want to get information about, whether active or in active.

3. StartDate [Optional]: Required if you want to view the lists created within a specific date

range.

4. EndDate [Optional]: Required if you want to view the lists created within a specific date range.

Input XML

Output:

<DATASET>

<CONSTANT>

<ApiKey>[value]</ApiKey>

</CONSTANT>

<INPUT>

<LID>[value]</LID>


<StartDate>[value]</StartDate>

<EndDate>[value]</EndDate>

</INPUT>

</DATASET>

1. Name: Name of the list.

2. LID: ID of the list.

3. Confirmed: Number of confirmed users in the list.

4. Unconfirmed: Number of unconfirmed users in the list.

5. Blacklisted: Number of blacklisted users in the list.

6. Disabled: Number of disabled users in the list.

7. Total: Total number of users in the list.

8. Messages: Total number of Campaigns sent to the list.

9. LastSent: Date on which last campaign was sent to the list Id.

Output XML

<DATASET>


<OUTPUT>

<RECORD>


<LID>[value]</LID>

<Confirmed>[value]</Confirmed>

<Unconfirmed>[value]</Unconfirmed>

<Blacklisted>[value]</Blacklisted>

<Disabled>[value]</Disabled>

<Total>[value]</Total>

<Messages>[value]</Messages>

<LastSent>[value]</LastSent>

</RECORD>

</OUTPUT></DATASET>

Sample API call:

Input XML:


type=list&activity=Delete&

data=<DATASET>


</CONSTANT>

<INPUT><LID>20</LID></INPUT>

</DATASET>

Output XML:


<OUTPUT><RECORD>

<Name>New Customers</Name>

<LID>34</LID>

<Confirmed>23 </Confirmed>

<Unconfirmed>23</Unconfirmed>


<Blacklisted>31</Blacklisted>

<Disabled>13</Disabled>

<Total>21</Total>

<Messages>23</Messages>

<LastSent>2014-11-20</LastSent>

</RECORD>

</OUTPUT></DATASET>

NOTE: If you provide multiple list ids, accordingly, multiple records are fetched.

4.3.5 DataUpload

You can use this activity to upload data into existing lists.

[type] : list

[activity] : DataUpload

Input parameters:

1. Operation: Adding, deleting and blacklisting are the three different operations that you

might want to do.

Add: Add is equivalent to upload users in bulk for specified list Id's. For add operation, list ID

is a mandatory input. You can pass multiple list Id's.

Delete: Delete is equivalent to delete users in bulk for specified list Id's. For delete operation,

list ID is not mandatory. You can pass multiple list Id's.

Blacklist: Blacklist is equivalent to blacklist users in bulk for specified list Id's. For blacklist

operation, list ID is not required.

2. LID: ID of the list.

3. Path [Required]: Path of the file which is to be uploaded. File path can be HTTP, FTP, FTPS, or

HTTPS location.

Example: ftp://qa:q@#[email protected]/20140810.xls

You have to use your FTP account username and password to access the attachment.

4. NotifyEmail: Email Address of the user who has to be notified when upload is completed.

5. CallbackUrl: URL where the upload data status needs to be posted.

6. TaskPriority: Priority of the upload task.

Priority can be as defined below:

1- Top priority

2- Default priority

3- Least priority

The job with top priority is executed first, irrespective of the time it is submitted. If job priority is

not defined, jobs are executed based on First In First Out (FIFO) principle. Any value passed other

than defined above is considered as default priority, that is, 2.

Input XML

Output XML

<DATASET>

<CONSTANT>


</CONSTANT>

<INPUT>

<LID>[Value]</LID>

<Operation>[Value]</Operation>

<Path>[Value]</Path>

<NotifyEmail>[Value]</NotifyEmail>

<TaskPriority>[Value]</TaskPriority>

<CallbackUrl>[Value]</CallbackUrl>

</INPUT>

</DATASET>

The job Id of the API call is returned as output.

<DATASET>


<OUTPUT>

<JOBID>[Value]</JOBID>

</OUTPUT>

</DATASET>

Sample API Call:

Input XML:


type=list&activity=DataUpload&

data=<DATASET>


</CONSTANT>

<INPUT>

<LID>12</LID><Operation>Add</Operation><Path>

ftp://qa:q@#[email protected]/20140810.xls </Path>

<NotifyEmail>

[email protected] </NotifyEmail> <TaskPriority> 1 </TaskPriority>

<CallbackUrl

> http://mydomain.com/track/callback.php </CallbackUrl>

</INPUT>

</DATASET>

Output XML:

<DATASET>


<OUTPUT>

<JOBID>23</JOBID>

</OUTPUT>

</DATASET>

4.3.6 MostActive

You can use this activity to generate reports of the Most Active Users. When the report is ready, the

API sends a notification to the email address specified in the email parameter.

mailto:[email protected]%3C/NotifyEmail%3E%20%3CTaskPriority%3E1%3C/TaskPriority%3E%20%3CCallbackUrl%3Esampleurl%3C/CallbackUrl%3E%3C/INPUT





The following criteria is considered while extracting the Most Active Users data:

Confirmed=1, Blacklisted=0, Disabled=0

[type] : list

[activity] : DataUpload

Input parameters:

1. LID [Optional]: If not specified, active users are extracted from the entire user base. If

specified, active users from the specified lists Id's are retrieved. You can provide multiple ids in

comma-separated format.

2. SubscribeStartDate & SubscribeEndDate: Date range when the users

subscribed to particular list. This input is valid only if specific list Id's are specified.

3. SystemStartDate & SystemEndDate: Date range when the users are added to the

user base, irrespective of the time when they are added to the list.

4. ViewStartDate & ViewEndDate: Date range when the user have viewed the

campaign.

5. No of opens: Number of campaigns the user has viewed. If not specified, details of the

users who have viewed at-least one campaign is retrieved.

6. TaskPriority: Priority of the job.

7. NotifyEmail: Email Address of the user to be notified when upload is completed.

8. CallbackUrl: URL where the upload data status needs to be posted.

Input XML

Output XML

<DATASET>

<CONSTANT>


</CONSTANT>

<INPUT><LID>[Value]</LID>



<SubscribeStartDate>[Value]</SubscribeStartDate>

<SubscribeEndDate>[Value]</SubscribeEndDate>

<SystemStartDate>[Value]</SystemStartDate>

<SystemEndDate>[Value]</SystemEndDate>

<ViewStartDate>[Value]</ViewStartDate>

<ViewEndDate>[Value]</ViewEndDate>

<Noofopens>[Value]</Noofopens>


</INPUT>

</DATASET>

<DATASET>


<OUTPUT><JOBID>[Value]</JOBID></OUTPUT>

</DATASET>

Sample API Call:

The job Id of the API call is returned as output.

Input XML:


type=list&activity=ListData&


data=<DATASET>


</CONSTANT>

<INPUT><LID>3</LID><AttrId>12</AttrId><StartDate>2014-11-05</

StartDate><EndDate>2014-11-20</EndDate><ModDate>2014-11-19</

ModDate><NotifyEmail>[email protected] </

NotifyEmail><CallbackUrl> value </CallbackUrl><Query> All </

Query><TaskPriority> 0 </TaskPriority></INPUT >

</DATASET>

Output XML:

<DATASET>


<OUTPUT><JOBID>12</JOBID></OUTPUT>

</DATASET>

4.3.7 BatchUpload

You can use this activity to upload data into existing list.

[type] : list

[activity] : BatchUpload

Input parameters:

1. LID: ID of the list to which you want to upload data.

2. UDETAILS: Email addresses which you want to upload.

Recommended batch sample size is 5000 records in one batch. Each record must be added in a

new line, that is (\n) separator.

The first record should be the header. For example,

Email,First_name,Last_name,Mobile_number

[email protected],James,Smith,9843509538

[email protected],Alen,Kidd,3424654346


Input XML

mailto:[email protected]%3C/NotifyEmail%3E%3CCallbackUrl%3Evalue%3C/CallbackUrl%3E%3CQuery%3EAll%3C/Query%3E%3CTaskPriority%3E0%3C/TaskPriority%3E%3C/INPUT



Output XML

<DATASET>


<INPUT>

<LID>[Value]</LID>

<UDETAILS>[Value]</UDETAILS>


</INPUT>

</DATASET>

<DATASET>

<TYPE>[Value]</TYPE>

<OUTPUT><JOBID>[Value]</JOBID></OUTPUT>

</DATASET>

Sample API Call:

Input XML:


type=list&activity=BatchUpload&

data=<DATASET>


</CONSTANT>

<INPUT><LID>6</LID>


<UDETAILS> Email,First_name,Last_name,Mobile_number

[email protected],abc,efg,1212121212

[email protected],xyz,pqr,1323232323</UDETAILS>

<NotifyEmail>[email protected] </NotifyEmail >

</INPUT></DATASET>

Output XML:

<DATASET>



</DATASET>

4.3.8 ListData

You can use this activity to get the list of users who are confirmed, unconfirmed, blacklisted, and

deleted. When the report is ready, the API sends a notification to the email address specified in the

email parameter.

[type] : list

[activity] : ListData

Input parameters:

1. LID [Optional]: List id is not mandatory. If not specified, active users are extracted from the

entire user base. If specified, active users from the specified lists Id's are retrieved. Multiple list Id's

can be provided in comma separated format.

2. AttrId [Optional]: Attribute Id's of the attributes that you want to export. If not specified, all

the attributes are exported.

3. StartDate, EndDate [Optional]: If list Id is specified then date range works on user

subscription date in that particular list. If list id is not specified then date range works on user

added date irrespective of the list.

5. ModDate: If list Id is specified then the system considers the list subscription date need to be

considered. Else if list Id is not specified then system date of that user.

6. Query: Query defines the type of users to be exported.

All: All user irrespective of their type.

Confirmed: Get only confirmed users.

Blacklisted: Get only blacklisted users.

mailto:[email protected]%3C/NotifyEmail

mailto:[email protected]%3C/UDETAILS

Disabled: Get only disabled users.

Unconfirmed: Get only unconfirmed users.

7. TaskPriority: Priority of this job.


9. CallbackUrl: URL where the upload data status need to be posted.

Input XML

Output XML

<DATASET>

<CONSTANT>


</CONSTANT>

<INPUT>

<LID>[Value]</LID>

<AttrId>[Value]</AttrId>

<StartDate>[Value]</StartDate>

<EndDate>[Value]</EndDate>

<ModDate>[Value]</ModDate>



<Query>[Value]</Query>


</INPUT>

</DATASET>

<DATASET><TYPE>[value]</TYPE>

<OUTPUT>


</OUTPUT>

</DATASET>

Sample API Call:

Input XML:


type=list&activity=ListData&

data=<DATASET>


</CONSTANT>

<INPUT>

<LID>3</LID><AttrId>12</AttrId><StartDate>2014-11-05</

StartDate><EndDate>2014-11-20</EndDate><ModDate>2014-11-19</

ModDate><NotifyEmail>[email protected]</

NotifyEmail><CallbackUrl>http://mydomain.com/track/

callback.php</CallbackUrl><Query>All</Query><TaskPriority>1</

TaskPriority></INPUT>

</DATASET>

Output XML:

<DATASET>



<OUTPUT>

<JOBID>12</JOBID>

</OUTPUT>

</DATASET>

2.13 4.4 ContactContact is the individual contact or your customer. The contacts can be:

a. Confirmed: users are those users who are confirmed as registered users and ready to receive the

email campaigns from EMM.

b. Unconfirmed: users are those who are added to the system through online registrations and are

in the ‘Awaiting’ category. They are added to the confirmed user’s category after verification of the

email address.

c. Blacklisted: users are those who have unsubscribed themselves, who have marked the emails as

spam and those addresses from which the emails have hard-bounced.

The following activities associated with Contacts can be performed using the API listed in this

section:

1 Add: to add a contact to a list.

1. QueryData: to retrieve a contact’s attribute data, unique ID, List Ids and status.

2. QueryStats: to retrieve statistical data for a contact, such as sent, click through, and open

history.

3. Update: to update a contact.

4. Delete: to delete a contact.

4.4.1 Add

You can use this activity to add a contact to the mailing list.

[type] : contact

[activity] : Add

Input parameters:

1. AddEmail [Required]: Email address that you want to add.

2. ID: ID of the attributes you want to add. To know more about attributes, please see attribute

types.

3. Value: Values of the attributes.

4. ListMember [Required]: Id of the list to which you want to add the user.

5. DoubleOptin: used for checking if user confirmation is required before subscription. If the

value is 1, a confirmation email is required to confirm the user, and 0 denotes that that user is

confirmed directly, without a confirmation email.

6. TriggerEmail: Campaign ID of the campaign that needs to be triggered to this user.

Input XML

Output XML

<DATASET>


<INPUT>

<Unique_id>[Value]</Unique_id>

<AddEmail>[Value]</AddEmail>

<AttributeValues>

<RECORD>

<ID>[Value]</ID>

<Value>[Value]</Value>

</RECORD>

</AttributeValues>

<Attributecount>[Value]</Attributecount>

<ListMember>[Value]</ListMember>

<DoubleOptin>[Value]</DoubleOptin>

<TriggerEmail>[Value]</TriggerEmail>

</INPUT>

</DATASET>

<DATASET>


<OUTPUT><USERID>[Value]</USERID></OUTPUT>

</DATASET>

Sample API Call:

User id is returned as an output.

Input XML:


type=contact&activity=Add&

data=<DATASET>


</CONSTANT>

<INPUT>

<Unique_id>2</Unique_id>

<AddEmail>[email protected] </AddEmail>

<AttributeValues> sample attributes</AttributeValues>

<Attributecount>1</Attributecount>

<ListMember>2</ListMember><DoubleOptin>1</

DoubleOptin><TriggerEmail></TriggerEmail>

</INPUT></DATASET>

Output XML:

<DATASET>


<OUTPUT><USERID>2</USERID></OUTPUT>

</DATASET>

4.4.2 Query

You can use this activity to retrieve the contact’s attribute data, unique ID, and status.

mailto:[email protected]%3C/AddEmail%3E%20%3CAttributeValues%3Esample

mailto:[email protected]%3C/AddEmail%3E%20%3CAttributeValues%3Esample


[type] : contact

[activity] : Query

Input parameters:

1. Emailaddress [Required]: Email address whose details are required.

Input XML

(Output):

<DATASET>


<INPUT>

<Emailaddress>[Value]</Emailaddress>

</INPUT>

</DATASET>

Userid:ID of the email address provided

Emailaddress: Email address of the user.

Confirmed: Confirmed user flag.

Blacklisted: Blacklisted user flag.

Disabled: Disabled user flag.

Entered: Entered date of the user.

Modified: Modified date of the user.

Bouncecount: Number of bounces received.

MailsSent: Number of campaigns sent to this user.

AttributeValues: Values of the attributes.

ListDetails: Subscription details for the user.

Output XML

<DATASET>


<OUTPUT>

<Userid>[Value]</Userid>


<Confirmed>[Value]</Confirmed>

<Blacklisted>[Value]</Blacklisted>

<Disabled>[Value]</Disabled>

<Entered>[Value]</Entered>

<Modified>[Value]</Modified>

<Bouncecount>[Value]</Bouncecount>

<MailsSent>[Value]</MailsSent>

<AttributeValues>

<RECORD>

<ID>[Value]</ID>

</RECORD>

</AttributeValues>

<ListDetails>[Value]</ListDetails>

</OUTPUT>

</DATASET>

Sample API Call:

Input XML:



type=contact&activity=Query&

data=<DATASET>


</CONSTANT>

<INPUT><Emailaddress>[email protected]</Emailaddress>

</INPUT></DATASET>

Output XML:

<DATASET><TYPE>success</TYPE><OUTPUT><Userid>5</Userid>

<Emailaddress>[email protected]</Emailaddress>

<Confirmed>1</Confirmed>

<Blacklisted>0</Blacklisted>

<Disabled>0</Disabled>

<Entered>2014-11-20</Entered>

<Modified>2014-11-21</Modified>

<Bouncecount>11</Bouncecount>

<MailsSent>5</MailsSent><AttributeValues>

<RECORD><ID>41</ID>

</RECORD>

</AttributeValues>

<ListDetails>1</ListDetails></OUTPUT></DATASET>

4.4.3 QueryStats

You can use this activity to retrieve statistical data for a contact, such as sent, click through, and

open history. The response returns the statistic type, the subject and date of the campaign,

timestamp, and frequency of the statistic.

[type] : contact

[activity] : QueryStats

Input parameters:

mailto:[email protected]%3C/Emailaddres

1. Emailaddress [Required]: Email address for which details are required.

2. StartDate & EndDate: Provide the date range if the campaign is sent to this user.

Input XML

Output:

<DATASET>

<CONSTANT>


</CONSTANT><INPUT>



<EndDate>[Value]</EndDate></INPUT>

</DATASET>

MessageId: Campaign ID of the campaigns received by the users.

Clicks: Number of clicks user has performed in the campaign.

SentDate: Date when the campaign was sent to the user.

BounceDate: Bounce date if campaign gets bounced.

ViewedDate: Date when the campaign was viewed by the user.

ResponseTime: Time difference between the time when the campaign was sent to this user

and the time when the campaign was viewed.

Output XML

<DATASET>


<OUTPUT>

<RECORD>

<MessageId>[Value]</MessageId>

<Clicks>[Value]</Clicks>

<SentDate>[Value]</SentDate>

<BounceDate>[Value]</BounceDate>

<ViewedDate>[Value]</ViewedDate>

<ResponseTime>[Value]</ResponseTime>

</RECORD></OUTPUT></DATASET>

Sample API Call:

4.4.4 Update

Input XML:


type=contact&activity=QueryStats&

data=<DATASET>


</CONSTANT>

<INPUT><Emailaddress>[email protected] </

Emailaddress><StartDate> 2014-11-19 </StartDate><EndDate> 2014-

11-28 </EndDate></INPUT></DATASET >

mailto:[email protected]%3C/Emailaddress%3E%3CStartDate%3E2014-11-19%3C/StartDate%3E%3CEndDate%3E2014-11-28%3C/EndDate%3E%3C/INPUT%3E%3C/DATASET




Output XML:

<DATASET><TYPE>success</TYPE><OUTPUT><RECORD>

<MessageId>2</MessageId>

<Clicks>12</Clicks>

<SentDate>2014-11-20</SentDate>

<BounceDate>2014-11-20</BounceDate>

<ViewedDate>2014-11-20</ViewedDate>

<ResponseTime>5</ResponseTime></RECORD></OUTPUT></DATASET>

You can use this activity to update a contact.

Input parameters:

1. AddEmail [Required]: Email address that you want to update.

2. ID: Attribute ID.

3. Value: Attribute value.

4. ListMember [Required]: Id of the list to which user is to be added.

5. Userid [Required]: ID of the user.

6. Confirmed: Confirmed status of the user.

Input XML

Output XML

<DATASET>


<INPUT><AddEmail>[Value]</AddEmail>

<AttributeValues>

<RECORD><ID>[Value]</ID>

<Value>[Value]</Value></RECORD>

</AttributeValues>

<ListMember>[Value]</ListMember>

<Userid>[Value]</Userid>

<Confirmed>[Value]</Confirmed></INPUT>

</DATASET>

User id is returned as an output.

<DATASET>

<TYPE>[value] </TYPE>

<OUTPUT>

<USERID>[Value]</USERID>

</OUTPUT>

</DATASET>

Input XML:


type=contact&activity=Update&

data=<DATASET>

<CONSTANT>

<ApiKey> abcde123fghijk456lmno789pqrst </ApiKey></CONSTANT>

<INPUT>

<AddEmail>[email protected]</AddEmail>

<AttributeValues>

<RECORD>

<ID>2</ID>

<Value>hello</Value>

</RECORD>

</AttributeValues>


<ListMember>5</ListMember>

<Userid>[email protected]</Userid>

<Confirmed>confirmed</Confirmed>

</INPUT>

</DATASET>

Output XML:

<DATASET>

<TYPE>success </TYPE>

<OUTPUT>

<USERID>14</USERID></OUTPUT></DATASET>

4.4.5 Delete

You can use this activity to delete a contact.

[type] : contact

[activity] : Delete

Input parameters:

1. Emailaddress [Required]: Email address whose details are required.

Input XML

Output XML

<DATASET>

<CONSTANT>


</CONSTANT>

<INPUT>


</INPUT>

</DATASET>

<DATASET>


<OUTPUT><USERID>[value] </USERID></OUTPUT>

</DATASET>

Sample API Call:

2.14 4.5 Report

Input XML:


type=contact&activity=Delete&

data=<DATASET>

<CONSTANT><ApiKey> abcde123fghijk456lmno789pqrst </ApiKey>

</CONSTANT>

<INPUT><Emailaddress>[email protected]</Emailaddress>

</INPUT></DATASET>

Output XML:

<DATASET>


<OUTPUT><USERID>2</USERID></OUTPUT>

</DATASET>

Report module enables you to view reports related to campaigns, lists, and so on.

The following activities associated with reports, can be performed using the API listed in this

section:

1 Summary: to send the detailed counts of the activities.


1. Download: to download details of a particular campaign id.

2. Daywise: to view the day wise reports.

4.5.1 Summary

Input parameters:

[type]:report

[activity] : summary

Input Parameters:

1. MsgId [Optional]: Used for searching report data for specific campaign id(s). You can pass

multiple campaign ids in comma separated format.

2. StartDate, EndDate, StartTime, EndTime [Optional]: Used for searching

reports within a specified date and time range.

3. Sent [Optional]: The number of mails sent in a particular campaign are shown in the report if

this tag is set to '1'.

4. Clicks [Optional]: The number of clicks for the campaign is shown in the report if this tag is

set to '1'.

5. Open [Optional]: The number of opens for the campaign is be shown in the report if this tag is

set to '1'.

6. Forward [Optional]: The number of forwards for the campaign is shown in the report if this

tag is set to '1'.

7. Abuse [Optional]: The number of report abuse for the campaign is shown in the report if this

tag is set to '1'.

8. Unsub [Optional]: The number of unsubscriptions for the campaign are shown in the report if

this tag is set to '1'.

9. Bounce [Optional]: The number of bounces for the campaign are shown in the report if this

tag is set to '1'.

10. HardBounce: The number of hardbounces for the campaign.

11. SoftBounce: The number of hardbounces for the campaign

12. Fb_like: The number of Facebook likes for the campaign.

13. Fb_comment: The number of Facebook comments for the campaign.

14. Retweet: The number of times the campaign has been retweeted on Twitter.

15. Subject [Optional]: The subject of the campaign is fetched in the reports if this tag is set to

'1'.

16. Fromfield [Optional]: The ‘From’ email id for the campaign is fetched in the reports if this

tag is set to '1'.

17. Entered [Optional]: The entered date for the campaign is fetched in the reports if this tag is

set to '1'.

18. SentDate [Optional]: The sent date for the campaign is fetched in the reports if this tag is

set to '1'.

19. Scheduled [Optional]: The scheduled date for the campaign is fetched in the reports if this

tag is set to '1'.

20. Size [Optional]: The size of the campaign( in KB) is fetched in the reports if this tag is set to

'1'.

NOTE: For parameters 3 through 15, if the tag value is set to ‘1’, the corresponding information is shown in the report.

If the tag is not present, or the value passed is 0, the report does not have the corresponding information.

For example, if the value for Size parameter is passed as 0, the report does not have information about Size.

21. Lists [Optional]: The list ids of a campaign is fetched in the reports if this tag is set to '1'.

The name of the list is fetched if value sent between the tags is set to 'name'. If the tag is not

present or if the value is passed as '0' then the report fetched does not have this information.

22. Templates [Optional]: The template id of a campaign is fetched in the reports if this tag is

set to '1'. The name of the template is fetched if value of the tag is set as 'name'. If the tag is not

present or if the value is passed as '0', then the report fetched does not have this information.

23. Owner [Optional]: The owner id of a campaign is fetched in the reports if this tag is set to '1'.

The name of the owner is fetched if value of the tag is set as 'name'. If the tag is not present or if

the value is passed as '0' then the report fetched does not have this information.

24. UniqueClickPercentage [Optional]: Unique click percentage for a campaign is

fetched if this tag is set to '1'. If the tag is not present or if the value is passed as '0' then the

report fetched does not have this information.

Input XML

<DATASET>


<CRITERIA><MsgId>[Value]</MsgId>



<StartTime>[Value]</StartTime>

<EndTime>[Value]</EndTime></CRITERIA>

<INPUT><Sent>[Value]</Sent><Clicks>[Value]</Clicks>

<Open>[Value]</Open><Forward>[Value]</Forward>

<Abuse>[Value]</Abuse><Unsub>[Value]</Unsub>

<Bounce>[Value]</Bounce><HardBounce>[Value]</HardBounce>

<SoftBounce>[Value]</SoftBounce><Subject>[Value]</Subject>

<Fb_like>[Value]</Fb_like><Fb_comment>[Value]</Fb_comment>

<Retweet>[Value]</Retweet><Fromfield>[Value]</Fromfield>

<Entered>[Value]</Entered><SentDate>[Value]</SentDate>

<Scheduled>[Value]</Scheduled><Size>[Value]</Size>

<Lists>[Value]</Lists><Templates>[Value]</Templates>

<Owner>[Value]</Owner><OpenPercentage>[Value]</OpenPercentage>

<TotalClickPercentage>[Value]</TotalClickPercentage>

<UniqueClickPercentage>[Value]</

UniqueClickPercentage><TotalClick>[Value]</TotalClick>

<TotalOpen>[Value]</TotalOpen></INPUT></DATASET>

Output:

The output XML has the count for Sent, Bounce, Clicks, Open, Forward, Abuse, Unsub, Fb_likes, and

Fb_comment.

Fromfield: Provides the From email address.

Subject: Provides the Subject of the campaign.

Entered: Provides the entered date of the campaign.

SentDate: Provides the sent date of the campaign.

Size: Provides the size of the campaign.

Scheduled: Provides the scheduled date and time when the campaign was sent.

Templates: Provides the Template id or name.

Owner: Provides the Owner id or name.

UniqueClickPercentage: provides the unique click percentage.

Output XML

<DATASET><TYPE>[value]</TYPE><RECORD>

<Messageid>[Value]</Messageid>

<Sent>[Value]</Sent>

<Bounce>[Value]</Bounce>

<Clicks>[Value]</Clicks>

<Open>[Value]</Open>

<Forward>[Value]</Forward>

<Abuse>[Value]</Abuse>

<Unsub>[Value]</Unsub>

<Fromfield>[Value]</Fromfield>

<Subject>[Value]</Subject>



<Size>[Value]</Size>

<Scheduled>[Value]</Scheduled>

<Templates>[Value]</Templates>

<Owner>[Value]</Owner>

<UniqueClickPercentage>[Value]</UniqueClickPercentage>

</RECORD>

</DATASET>

Sample API Call:

4.5.2 Download

Input XML:

https://api.exacttouch.com/API/mailing/ ?

type=report&activity=summary&data=<DATASET>

<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst </ApiKey>

</CONSTANT>

https://api.exacttouch.com/API/mailing/%20?type=report&activity=summary&data=%3CDATASET

https://api.exacttouch.com/API/mailing/%20?type=report&activity=summary&data=%3CDATASET

<CRITERIA><MsgId>2</MsgId><StartDate>12-11-2014</

StartDate><EndDate>25-11-2014</EndDate><StartTime>13.00</

StartTime><EndTime>14.00</EndTime></CRITERIA>

<INPUT><Sent>1</Sent><Clicks>1</Clicks><Open>1</

Open><Forward>1</Forward><Abuse>1</Abuse><Unsub>1</

Unsub><Bounce>1</Bounce><HardBounce>1</

HardBounce><SoftBounce>1</SoftBounce><Subject>0</

Subject><Fb_like>1</Fb_like><Fb_comment>1</

Fb_comment><Retweet>1</Retweet><Fromfield>1</

Fromfield><Entered>0</Entered><SentDate>0</

SentDate><Scheduled>0</Scheduled><Size>0</Size><Lists>name</

Lists><Templates>0</Templates><Owner>0</

Owner><OpenPercentage>1</

OpenPercentage><TotalClickPercentage>1</

TotalClickPercentage><UniqueClickPercentage>1</

UniqueClickPercentage><TotalClick>1</

TotalClick><TotalOpen>1</TotalOpen>

</INPUT>

</DATASET>

[type]:report

[activity] : download

Input Parameters:

1. MsgId [Optional]: Used for searching report data for specific campaign id or ids. Multiple

campaign ids can be passed separated with commas.

2. StartDate, EndDate, StartTime, EndTime [Optional]: Used for searching

reports within a date range.

6. Attributes [Optional]: The Ids of all the attributes which has to be downloaded along

with the corresponding email ids should be provided in this tag. Comma separated attribute ids

will be passed as a value in this tag. By default all attributes are downloaded if nothing is specified.

6. Action [Required]: The action for which the report has to be downloaded is provided in this

tag. Reports can be downloaded for Sent, Clicks, Open, Forward, Abuse, Unsub, Bounce, Fb_like,

Fb_comment, and Retweet.

7. Subject: The subject for the campaign is fetched in the reports if this tag is set to '1'.

8. Fromfield: The From email id for the campaign is fetched in the reports if this tag is set to

'1'.

9. Entered: The entered date for the campaign is fetched in the reports if this tag is set to '1'.

10. SentDate: The sent date for the campaign is fetched in the reports if this tag is set to '1'.

11. Scheduled: The scheduled date for the campaign is fetched in the reports if this tag is set

to '1'.

12. Size: The size of the campaign is fetched in the reports if this tag is set to '1'.

13. Listsl: The list ids of a campaign will be fetched in the reports if this tag is set to '1'. The

name of the list will be fetched if value sent between the tag as name.

14. Templates: The template id of a campaign is fetched in the reports if this tag is set to '1'.

The name of the template is fetched if value of the tag is set as 'name'.

Note: For parameters 7 through 14, if the tag value is set to ‘1’, the corresponding information is shown in the report.

If the tag is not present, or the value passed is 0, the report does not have the corresponding information.

15. NotifyEmail: The email id has to be provided in this tag. The link for downloading the

report file is sent to this email id.

16. CallbackUrl: URL specified to which output is to be posted.

Input XML

<DATASET>

<CONSTANT>

<ApiKey>[Value]</ApiKey></CONSTANT><CRITERIA>

<MsgId>[Value]</MsgId>



<StartTime>[Value]</StartTime>

<EndTime>[Value]</EndTime>

<Attributes>[Value]</Attributes>

<Action>[Value]</Action>

</CRITERIA><INPUT>

<Subject>[Value]</Subject>

<Fromfield>[Value]</Fromfield>



<Scheduled>[Value]</Scheduled>

<Size>[Value]</Size>

<Lists>[Value]</Lists>

<Templates>[Value]</Templates>

<Owner>[Value]</Owner>


<CallbackUrl>[Value]</CallbackUrl></INPUT></DATASET>

Output:

Jobid: This tag provides the job id using which the status and other information on the job can

be fetched.

Output XML

<DATASET>


<RECORD><Jobid>[Value]</Jobid></RECORD>

< /DATASET>

Sample API Call:

4.5.3 Daywise

Input XML:


type=report&activity=download&data=<DATASET>


</CONSTANT><CRITERIA><MsgId>2</MsgId><StartDate>12-11-2014</

StartDate><EndDate>27-11-2014</EndDate><StartTime>13.00</

StartTime><EndTime>14.00</EndTime><Attributes>sample</

Attributes><Action>Fb_like</Action></

CRITERIA><DOWNLOAD><Merge>1</Merge></DOWNLOAD><INPUT><Subject>

weeklyoffer</Subject><Fromfield>marketing</

Fromfield><Entered>0</Entered><SentDate>27-11-2014</

SentDate><Scheduled>0</Scheduled><Size>4</Size><Lists>13</

Lists><Templates>5</Templates><Owner>0</

Owner><NotifyEmail>[email protected] </

NotifyEmail><CallbackUrl> http://mydomain.com/track/

callback.php </CallbackUrl></INPUT></DATASET >

Output XML:

mailto:[email protected]%3C/NotifyEmail%3E%3CCallbackUrl%3Ehttp://mydomain.com/track/callback.php%3C/CallbackUrl%3E%3C/INPUT%3E%3C/DATASET




<DATASET>


<RECORD><Jobid>6</Jobid></RECORD>

< /DATASET>

[type] : report

[activity] : daywise

Input Parameters:

1. StartDate, EndDate: Used for searching reports within a date range. This tag is optional.

Input XML

Output:

<DATASET>

<CONSTANT>


</CONSTANT><CRITERIA>



</CRITERIA>

<INPUT>



<Bounce>[Value]</Bounce></INPUT>

</DATASET>

Unsubscribes, Abuse and Bounce counts are provided in the output XML.

Output XML

<RECORD>

<Date>[Value]</Date>



<Bounce>[Value]</Bounce>

</RECORD>

Sample API Call:

2.15 4.6 Jobs

Input XML:


type=report&activity=daywise&data=<DATASET>


</CONSTANT><CRITERIA><StartDate>10-11-2014</

StartDate><EndDate>27-11-2014</EndDate></

CRITERIA><INPUT><Abuse>1</Abuse><Unsub>1</Unsub><Bounce>1</

Bounce></INPUT></DATASET>

Output XML:

<RECORD>

<Date>2014-11-20</Date>

<Unsub>7</Unsub>

<Abuse>2</Abuse>

<Bounce>4</Bounce>

</RECORD>

Jobs are tasks performed in EMM. Each task is identified with a job id using which you can track the

task. The jobs are defined on the basis of their priority. There are three different task priorities

defined in EMM:

Top priorit-1

Default priority-2


Least priority-3

These APIs enable you to perform the following activities associated with jobs:

1 Status: to view the status of a job.

1. Update: to update the details of a job.

2. Delete: to remove a job from the queue.

4.6.1 Status

[type]: job

[activity]: Status

Input Parameters:

1. JOBID [Required]: Id of the job for which you want to check the status.

Input XML

Output:

<DATASET>

<CONSTANT>


</CONSTANT>

<INPUT><JOBID>[Value]</JOBID></INPUT>

</DATASET>

JOBID: Id of the requested job.

Status: Status of the job.

Entered: Date when the job was added.

Priority: Priority of the job.

NotifyEmail: Email address to which you want to send the status of job.

CallbackUrl: URL specified to which output is to be posted.

Output XML

<DATASET>

<TYPE>[Value]</TYPE>

<OUTPUT>


<Status>[Value]</Status>


<Priority>[Value]</Priority>



</OUTPUT>

</DATASET>

Sample API Call:

4.6.2 Update

Input XML:


type=job&activity=Status&

data=<DATASET>


</CONSTANT>

<INPUT><JOBID>23</JOBID></INPUT>

</DATASET>

Output XML:

<DATASET>


<OUTPUT>

<JOBID>3</JOBID>

<Status>Entered</Status>

<Entered>2014-11-05</Entered>

<Priority>2</Priority>

<NotifyEmail>[email protected]</NotifyEmail>

<CallbackUrl>http://mydomain.com/track/callback.php</

CallbackUrl>

</OUTPUT>

</DATASET>

[type] : job

[activity] :Update

Input Parameters:

1. JOBID [Required]: Id of the job you want to update.


2. Priority: Priority of the job.

3. NotifyEmail: Email address to which you want to send the status of job

4. CallbackUrl: URL specified to which output is to be posted.

Input XML

Output:

<DATASET>

<CONSTANT>


</CONSTANT>

<INPUT>





</INPUT>

</DATASET>

JOBID: Job ID to be updated.

Output XML

S ample API Call:

<DATASET>


<OUTPUT><JOBID>[value]</JOBID></OUTPUT>

</DATASET>

4.6.3 Delete

Input XML:


type=job&activity=Update&

data=<DATASET>

<CONSTANT>


</CONSTANT>

<INPUT><JOBID>34</JOBID>

<NotifyEmail>[email protected]</NotifyEmail>

<TaskPriority>1</TaskPriority>

</INPUT>

</DATASET>

Output XML:

<DATASET>



</DATASET>

[type]: job

[activity] : delete

Input Parameters:

1. JOBID [Required]: Id of the job that you want to delete.

Input XML

Output:

<DATASET>


<CONSTANT>


</CONSTANT>

<INPUT><JOBID>[Value]</JOBID></INPUT>

</DATASET>

JOBID: Job ID to be removed.

Output XML

<DATASET>


<OUTPUT>

<JOBID>Value removed</JOBID>

</OUTPUT>

</DATASET>

Sample API Call:


type=job&activity=Delete&

data=<DATASET>

<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst </ApiKey>

</CONSTANT>

<INPUT><JOBID>sample id</JOBID>

</INPUT>


</DATASET>

Output XML:

<DATASET>



</DATASET>

5. Support Team

The EMM support team is available to answer your questions or handle critical incidents. As email

management specialists, we can solve issues quickly – oftentimes before you even tell us. We

provide support via phone or live chat during weekdays from 9am to 7pm (IST).

If you have a question, call +91-(22)-66628081.

You may also submit a request online using your EMM Account or else drop a mail to

[email protected].

Emm API Guidev1.3

Documents

Transcript of Emm API Guidev1.3