Académique Documents
Professionnel Documents
Culture Documents
Management
API Guide
1 About netCORE
netCORE 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
Table of Contents
About netCORE.................................................................................................................1
1About the document.........................................................................................................1
1.1Intended Audience........................................................................................................
1.2Organization of the document.........................................................................................
1.Overview of Email Marketing Management..........................................................................2
2.1 EMM API.....................................................................................................................
2.2 Why Use the API?.........................................................................................................
2.3 Not a Programmer?......................................................................................................
2.Get Started with the EMM API...........................................................................................2
3.1 Module.......................................................................................................................
3.2 Action.........................................................................................................................
3.3 Data...........................................................................................................................
3.4 Syntax for API requests.................................................................................................
3.EMM API library..............................................................................................................3
4.1 Campaign...................................................................................................................
4.1.1 Query......................................................................................................................
4.1.2 Add.........................................................................................................................
4.1.3 Quicktest..................................................................................................................
4.1.4 Copy........................................................................................................................
4.1.5 Schedule..................................................................................................................
4.1.6 Suspend...................................................................................................................
4.1.7 Requeue..................................................................................................................
4.1.8 Trigger ....................................................................................................................
4.2 Attribute.....................................................................................................................
4.2.1 Add.........................................................................................................................
4.3.1Query.......................................................................................................................
4.3.2Update......................................................................................................................
4.3.3Download..................................................................................................................
4.3.4Delete.......................................................................................................................
4.3 List............................................................................................................................
4.3.1 Add.........................................................................................................................
4.3.2 Update.....................................................................................................................
4.3.3 Delete....................................................................................................................
4.3.4 ListSummary...........................................................................................................
4.3.5 DataUpload.............................................................................................................
4.3.6 MostActive..............................................................................................................
4.3.7 BatchUpload...........................................................................................................
4.3.8 ListData.................................................................................................................
4.4 Contact.....................................................................................................................12
4.4.1 Add.......................................................................................................................
4.4.2 Query....................................................................................................................
4.4.3 QueryStats.............................................................................................................
4.4.4 Update...................................................................................................................
4.4.5 Delete....................................................................................................................
4.5 Report......................................................................................................................15
4.5.1 Summary...............................................................................................................
4.5.2 Download...............................................................................................................
4.5.3 Daywise.................................................................................................................
4.6 Jobs.........................................................................................................................18
4.6.1 Status....................................................................................................................
4.6.2 Update...................................................................................................................
4.6.3 Delete...................................................................................................................
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.
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.
1.
Submit a request via HTTPS POST to EMM. For best results, use HTTPS POST.
2.
Campaign
2.
Attributes
3.
List
4.
Contact
5.
Report
6.
Jobs
NOTE: In the API call, specify the module in the type field.
add
delete
update
upload
download
NOTE: In your API call, specify the action in the activity field.
Constant: is the API key. You can obtain the API key from the EMM panel.
The input must be URL coded. In the API call, the data is specified as shown below:
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>marketing@domainname.c
om</FromName><FromEmail>cs@doaminname.com</FromEmail><DYNAMIC>
</DYNAMIC><ReplyTo>custexec@domainname.com</ReplyTo><TemplateI
D>1</TemplateID><SetLimit>4</SetLimit><MessageHTML><!
[CDATA[Hello,
This is the first email.
Thanks ]]></MessageHTML><MessageMobile>
<![CDATA[]]></MessageMobile><Attcount>1</Attcount>
</INPUT>
</DATASET>
1.
2.
3.
4.
5.
6.
7.
4.1.1 Query
You can use this activity to retrieve data related to a specific campaign.
[type] :
message
[activity] :
Query
Input parameters:
1.
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:
https://api.exacttouch.com/API/mailing/?
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.
2.
FromName
3.
4.
MessageHTML
[Required for HTML Campaigns]: The content of the HTML version of the
MessageMobile
[Optional]: The content of the Mobile version of the campaign that you
7.
Attachment [I] [Optional]: The HTTP URL or FTP location of the file to be attached. You can
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>
<TYPE>[value]</TYPE>
<OUTPUT><MID>[value]</MID></OUTPUT>
</DATASET>
Input XML:
https://api.exacttouch.com/API/mailing/?
type=message&activity=Add&
data=<DATASET>
<CONSTANT>
<ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>
</CONSTANT>
<INPUT><Subject>monthly newsletter</Subject>
<FromName>customersupport</FromName>
<FromEmail>cs@domainname.com</FromEmail><DYNAMIC></DYNAMIC><Re
plyTo></ReplyTo><TemplateID>1</TemplateID><SetLimit>4</SetLimi
t><MessageHTML><!
[CDATA[hello]]></MessageHTML><MessageMobile><!
[CDATA[]]></MessageMobile>
<Attcount>1</Attcount>
</INPUT></DATASET>
Output XML:
<DATASET>
<TYPE>success</TYPE>
<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
2.
Emails [Required]: The address to which the test is to be sent. You can provide multiple ids
[Required]: The campaign ID. You can provide multiple ids in comma separated format.
Output XML
<DATASET>
<CONSTANT><ApiKey>[value]</ApiKey></CONSTANT>
<INPUT><MID>[value]</MID>
<Emails>[value]</Emails></INPUT>
</DATASET>
<DATASET>
<TYPE>[value]</TYPE>
<OUTPUT>
<EmailSuccess>[value]</EmailSuccess>
<EmailFailure>[value]</EmailFailure>
<MID>[value]</MID>
</OUTPUT>
</DATASET>
Input XML:
https://api.exacttouch.com/API/mailing/?
type=message&activity=Quicktest&
data=<DATASET>
<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>
</CONSTANT>
<INPUT><MID>11</MID><Emails>cs@domainname.com
</Emails></INPUT>
</DATASET>
Output XML:
<DATASET>
<TYPE>success</TYPE>
<OUTPUT>
<EmailSuccess>admin@mydomainname.com</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.
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:
https://api.exacttouch.com/API/mailing/?
type=message&activity=Copy&
data=<DATASET>
<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>
</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 DeliveryYear, DeliveryMonth, DeliveryDay, and DeliveryHour parameters.
[type] :
message
[activity]:
Schedule
Input Parameters
1.
2.
List ID [Required]: The ID of the group to which you want to send the campaign.
3.
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>
<TYPE>[value]</TYPE>
<OUTPUT>
<MID>[value]</MID>
</OUTPUT>
</DATASET>
Input XML:
https://api.exacttouch.com/API/mailing/?
type=message&activity=Schedule&
data=<DATASET>
<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>
</CONSTANT>
<INPUT><MID>12</MID><DeliveryYear>2014</DeliveryYear><Delivery
Month>11</DeliveryMonth><DeliveryDate>25</DeliveryDate><Delive
ryHour>12</DeliveryHour><DeliveryMinute>00</DeliveryMinute>
<LID>10</LID>
</INPUT></DATASET>
Output XML:
<DATASET><TYPE>success</TYPE>
<OUTPUT><MID>3</MID></OUTPUT></DATASET>
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.
Input XML
Output XML
<DATASET>
<CONSTANT><ApiKey>[value]</ApiKey></CONSTANT>
<INPUT><MID>[value]</MID></INPUT>
</DATASET>
<DATASET>
<TYPE>[value]</TYPE>
<OUTPUT><MID>[value]</MID></OUTPUT>
</DATASET>
Input XML:
https://api.exacttouch.com/API/mailing/?
type=message&activity=Suspend&
data=<DATASET>
<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>
</CONSTANT>
<INPUT><MID>10</MID></INPUT>
</DATASET>
Output XML:
<DATASET><TYPE>success</TYPE>
<OUTPUT><MID>4</MID></OUTPUT></DATASET>
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.
Input XML:
<DATASET>
<CONSTANT><ApiKey>[value]</ApiKey></CONSTANT>
<INPUT><MID>[value]</MID></INPUT></DATASET>
Output XML
Sample API Call:
<DATASET>
<TYPE>[value]</TYPE>
<OUTPUT><MID>[MID] re queued successfully</MID></OUTPUT>
</DATASET>
Input XML:
https://api.exacttouch.com/API/mailing/?
type=message&activity=Requeue&
data=<DATASET>
<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>
</CONSTANT>
<INPUT><MID>12</MID></INPUT>
</DATASET>
Output XML:
<DATASET>
<TYPE>success</TYPE>
<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.
2.
3.
4.
<DATASET>
<CONSTANT><ApiKey>[value]</ApiKey></CONSTANT>
<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>
<TYPE>[value]</TYPE>
<OUTPUT><MID>[MID] triggered
successfully</MID></OUTPUT>
</DATASET>
Input XML:
https://api.exacttouch.com/API/mailing/?
type=message&activity=Trigger&
data=<DATASET>
<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>
</CONSTANT>
<INPUT><AddEmail>cs@domainname.com</AddEmail><ForeignKey>12</F
oreignKey><CcEmail>admin@doaminname.com</CcEmail><AttributeVal
ues>12</AttributeValues><TriggerEmail>13</TriggerEmail>
</INPUT>
</DATASET>
Output XML:
<DATASET>
<TYPE>success</TYPE>
<OUTPUT><MID>3 triggered successfully</MID></OUTPUT>
</DATASET>
1.
2.
3.
4.
4.2.1 Add
You can use this activity to add an attribute.
[type] :
attribute
[activity] :
Add
Input parameters:
1.
2.
Atttype: Type of the attribute you want to add. For more details, please see attribute types.
3.
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>
Input XML:
https://api.exacttouch.com/API/mailing/?
type=attribute&activity=Add&
data=<DATASET>
<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>
</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>
<CONSTANT><ApiKey>[Value]</ApiKey></CONSTANT>
<INPUT><Attid>[Value]</Attid></INPUT>
</DATASET>
<DATASET>
<TYPE>[value]</TYPE>
<OUTPUT>
<Attid>[Value]</Attid>
<Attname>[Value]</Attname>
<Atttype>[Value]</Atttype>
<Defaultval>[Value]</Defaultval>
</OUTPUT>
</DATASET>
Input XML:
https://api.exacttouch.com/API/mailing/?
type=attribute&activity=Query&
data=<DATASET>
<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>
</CONSTANT><INPUT><Attid>3</Attid></INPUT></DATASET>
Output XML:
<DATASET>
<TYPE>success</TYPE>
<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.
2.
3.
Atttype: Type of the attribute. To know about attribute types, please see this.
4.
Input XML
Output XML
<DATASET>
<CONSTANT><ApiKey>[Value]</ApiKey></CONSTANT>
<INPUT>
<Attid>[Value]</Attid>
<Attname>[Value]</Attname>
<Atttype>[Value]</Atttype>
<Defaultval>[Value]</Defaultval></INPUT>
</DATASET>
<DATASET>
<TYPE>success</TYPE>
<OUTPUT>
<Attid>[Value]</Attid>
<Atttype>[Value]</Atttype>
</OUTPUT>
</DATASET>
https://api.exacttouch.com/API/mailing/?
type=attribute&activity=Update&
data=<DATASET>
<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>
</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>
<CONSTANT><ApiKey>[value]</ApiKey></CONSTANT>
<INPUT><Attid>[value]</Attid></INPUT></DATASET>
Output XML
<DATASET>
<TYPE>[value]</TYPE>
<OUTPUT>
<RECORD>
<Attid>[value]</Attid>
<Name>[value]</Name>
<Type>[value]</Type>
<DefaultValue>[value]</DefaultValue>
<Required>[value]</Required>
</RECORD>
</OUTPUT>
</DATASET>
Input XML:
https://api.exacttouch.com/API/mailing/?
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>
<Name>[value]</Name>
<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>
<TYPE>[value]</TYPE>
<OUTPUT>
<Attid>[value]</Attid>
</OUTPUT>
</DATASET>
<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
1.
2.
3.
4.
5.
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.
2.
3.
Input XML
Output XML
<DATASET>
<CONSTANT><ApiKey>[value]</ApiKey></CONSTANT>
<INPUT>
<Name>[value]</Name>
<Description>[value]</Description>
<Active>[value]</Active>
</INPUT>
</DATASET>
<DATASET>
<TYPE>success</TYPE>
<OUTPUT><LID>[value]</LID></OUTPUT>
</DATASET>
Sample API call:
Input XML:
https://api.exacttouch.com/API/mailing/?
type=list&activity=Add&
data=<DATASET>
<CONSTANT>
<ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>
</CONSTANT>
<INPUT><Name>regular buyers group</Name><Description>monthly
offers </Description><Active>1</Active></INPUT>
</DATASET>
Output XML:
<DATASET>
<TYPE>success</TYPE>
<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.
2.
3.
4.
Input XML
Output XML
<DATASET>
<CONSTANT><ApiKey>[value]</ApiKey></CONSTANT>
<INPUT>
<LID>[value]</LID>
<Name>[value]</Name>
<Description>[value]</Description>
<Active>[value]</Active>
</INPUT>
</DATASET>
<DATASET>
<TYPE>[value]</TYPE>
<OUTPUT><LID>[value]</LID></OUTPUT>
</DATASET>
https://api.exacttouch.com/API/mailing/?
type=list&activity=Query&
data=<DATASET>
<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>
</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
<DATASET>
<CONSTANT><ApiKey>[value]</ApiKey></CONSTANT>
<INPUT><LID>[value]</LID></INPUT>
</DATASET>
<DATASET><TYPE>[value]</TYPE>
<OUTPUT><LID>[value]</LID></OUTPUT></DATASET>
Sample API call:
Input XML:
https://api.exacttouch.com/API/mailing/?
type=list&activity=Delete&
data=<DATASET>
<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>
</CONSTANT><INPUT><LID>5</LID></INPUT>
</DATASET>
Output XML:
<DATASET>
<TYPE>success</TYPE>
<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>
<Active>[value]</Active>
<StartDate>[value]</StartDate>
<EndDate>[value]</EndDate>
</INPUT>
</DATASET>
1.
2.
3.
4.
5.
6.
7.
8.
9.
LastSent: Date on which last campaign was sent to the list Id.
Output XML
<DATASET>
<TYPE>[value]</TYPE>
<OUTPUT>
<RECORD>
<Name>[value]</Name>
<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>
Input XML:
https://api.exacttouch.com/API/mailing/?
type=list&activity=Delete&
data=<DATASET>
<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>
</CONSTANT>
<INPUT><LID>20</LID></INPUT>
</DATASET>
Output XML:
<DATASET><TYPE>success</TYPE>
<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
list ID
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@#321@terra1.netcore.co.in/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.
6.
<DATASET>
<CONSTANT>
<ApiKey>[Value]</ApiKey>
</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>
<TYPE>[value]</TYPE>
<OUTPUT>
<JOBID>[Value]</JOBID>
</OUTPUT>
</DATASET>
Sample API Call:
Input XML:
https://api.exacttouch.com/API/mailing/?
type=list&activity=DataUpload&
data=<DATASET>
<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>
</CONSTANT>
<INPUT>
<LID>12</LID><Operation>Add</Operation><Path>
ftp://qa:q@#321@terra1.netcore.co.in/20140810.xls </Path>
<NotifyEmail>
cs@domainname.com</NotifyEmail> <TaskPriority>1</TaskPriority>
<CallbackUrl>http://mydomain.com/track/callback.php</CallbackU
rl>
</INPUT>
</DATASET>
Output XML:
<DATASET>
<TYPE>success</TYPE>
<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.
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.
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
7.
8.
Input XML
Output XML
<DATASET>
<CONSTANT>
<ApiKey>[Value]</ApiKey>
</CONSTANT>
<INPUT><LID>[Value]</LID>
<NotifyEmail>[Value]</NotifyEmail>
<CallbackUrl>[Value]</CallbackUrl>
<SubscribeStartDate>[Value]</SubscribeStartDate>
<SubscribeEndDate>[Value]</SubscribeEndDate>
<SystemStartDate>[Value]</SystemStartDate>
<SystemEndDate>[Value]</SystemEndDate>
<ViewStartDate>[Value]</ViewStartDate>
<ViewEndDate>[Value]</ViewEndDate>
<Noofopens>[Value]</Noofopens>
<TaskPriority>[Value]</TaskPriority>
</INPUT>
</DATASET>
<DATASET>
<TYPE>[value]</TYPE>
<OUTPUT><JOBID>[Value]</JOBID></OUTPUT>
</DATASET>
Sample API Call:
The job Id of the API call is returned as output.
Input XML:
https://api.exacttouch.com/API/mailing/?
type=list&activity=ListData&
data=<DATASET>
<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>
</CONSTANT>
<INPUT><LID>3</LID><AttrId>12</AttrId><StartDate>2014-1105</StartDate><EndDate>2014-11-20</EndDate><ModDate>2014-1119</ModDate><NotifyEmail>sample@emailid.com</NotifyEmail><Call
backUrl>value</CallbackUrl><Query>All</Query><TaskPriority>0</
TaskPriority></INPUT>
</DATASET>
Output XML:
<DATASET>
<TYPE>success</TYPE>
<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.
2.
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
jamessmith@gmail.com,James,Smith,9843509538
alenkidd@gmail.com,Alen,Kidd,3424654346
3.
Input XML
Output XML
<DATASET>
<CONSTANT><ApiKey>[Value]</ApiKey></CONSTANT>
<INPUT>
<LID>[Value]</LID>
<UDETAILS>[Value]</UDETAILS>
<NotifyEmail>[Value]</NotifyEmail>
</INPUT>
</DATASET>
<DATASET>
<TYPE>[Value]</TYPE>
<OUTPUT><JOBID>[Value]</JOBID></OUTPUT>
</DATASET>
Input XML:
https://api.exacttouch.com/API/mailing/?
type=list&activity=BatchUpload&
data=<DATASET>
<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>
</CONSTANT>
<INPUT><LID>6</LID>
<UDETAILS> Email,First_name,Last_name,Mobile_number
abc@gmail.com,abc,efg,1212121212
xyz@gmail.com,xyz,pqr,1323232323</UDETAILS>
<NotifyEmail>admin@domainname.com</NotifyEmail>
</INPUT></DATASET>
Output XML:
<DATASET>
<TYPE>success</TYPE>
<OUTPUT><JOBID>12</JOBID></OUTPUT>
</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,
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.
8.
9.
Input XML
Output XML
<DATASET>
<CONSTANT>
<ApiKey>[Value]</ApiKey>
</CONSTANT>
<INPUT>
<LID>[Value]</LID>
<AttrId>[Value]</AttrId>
<StartDate>[Value]</StartDate>
<EndDate>[Value]</EndDate>
<ModDate>[Value]</ModDate>
<NotifyEmail>[Value]</NotifyEmail>
<CallbackUrl>[Value]</CallbackUrl>
<Query>[Value]</Query>
<TaskPriority>[Value]</TaskPriority>
</INPUT>
</DATASET>
<DATASET><TYPE>[value]</TYPE>
<OUTPUT>
<JOBID>[Value]</JOBID>
</OUTPUT>
</DATASET>
Sample API Call:
Input XML:
https://api.exacttouch.com/API/mailing/?
type=list&activity=ListData&
data=<DATASET>
<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>
</CONSTANT>
<INPUT>
<LID>3</LID><AttrId>12</AttrId><StartDate>2014-1105</StartDate><EndDate>2014-11-20</EndDate><ModDate>2014-1119</ModDate><NotifyEmail>sample@emailid.com</NotifyEmail><Call
backUrl>http://mydomain.com/track/callback.php</CallbackUrl><Q
uery>All</Query><TaskPriority>1</TaskPriority></INPUT>
</DATASET>
Output XML:
<DATASET>
<TYPE>success</TYPE>
<OUTPUT>
<JOBID>12</JOBID>
</OUTPUT>
</DATASET>
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 users 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
1.
QueryData: to retrieve a contacts 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.
4.
4.4.1 Add
You can use this activity to add a contact to the mailing list.
[type] :
contact
[activity] :
Add
Input parameters:
1.
2.
ID: ID of the attributes you want to add. To know more about attributes, please see attribute
types.
3.
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.
Input XML
Output XML
<DATASET>
<CONSTANT><ApiKey>[Value]</ApiKey></CONSTANT>
<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>
<TYPE>success</TYPE>
<OUTPUT><USERID>[Value]</USERID></OUTPUT>
</DATASET>
Sample API Call:
User id is returned as an output.
Input XML:
https://api.exacttouch.com/API/mailing/?
type=contact&activity=Add&
data=<DATASET>
<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>
</CONSTANT>
<INPUT>
<Unique_id>2</Unique_id>
<AddEmail>sampleid@emailid.com</AddEmail>
<AttributeValues>sampleattributes</AttributeValues>
<Attributecount>1</Attributecount>
<ListMember>2</ListMember><DoubleOptin>1</DoubleOptin><Trigger
Email></TriggerEmail>
</INPUT></DATASET>
Output XML:
<DATASET>
<TYPE>success</TYPE>
<OUTPUT><USERID>2</USERID></OUTPUT>
</DATASET>
4.4.2 Query
You can use this activity to retrieve the contacts attribute data, unique ID, and status.
[type] :
contact
[activity] :
Query
Input parameters:
1.
Input XML
(Output):
<DATASET>
<CONSTANT><ApiKey>[Value]</ApiKey></CONSTANT>
<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>
<TYPE>success</TYPE>
<OUTPUT>
<Userid>[Value]</Userid>
<Emailaddress>[Value]</Emailaddress>
<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>
Input XML:
https://api.exacttouch.com/API/mailing/?
type=contact&activity=Query&
data=<DATASET>
<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>
</CONSTANT>
<INPUT><Emailaddress>sample@domainname.com</Emailaddress>
</INPUT></DATASET>
Output XML:
<DATASET><TYPE>success</TYPE><OUTPUT><Userid>5</Userid>
<Emailaddress>myemail@mydomain.com</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:
1.
2.
StartDate & EndDate: Provide the date range if the campaign is sent to this user.
Input XML
Output:
<DATASET>
<CONSTANT>
<ApiKey>[Value]</ApiKey>
</CONSTANT><INPUT>
<Emailaddress>[Value]</Emailaddress>
<StartDate>[Value]</StartDate>
<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>
<TYPE>[value]</TYPE>
<OUTPUT>
<RECORD>
<MessageId>[Value]</MessageId>
<Clicks>[Value]</Clicks>
<SentDate>[Value]</SentDate>
<BounceDate>[Value]</BounceDate>
<ViewedDate>[Value]</ViewedDate>
<ResponseTime>[Value]</ResponseTime>
</RECORD></OUTPUT></DATASET>
Input XML:
https://api.exacttouch.com/API/mailing/?
type=contact&activity=QueryStats&
data=<DATASET>
<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>
</CONSTANT>
<INPUT><Emailaddress>sample@domainname.com</Emailaddress><Star
tDate>2014-11-19</StartDate><EndDate>2014-1128</EndDate></INPUT></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.
2.
3.
4.
5.
6.
Input XML
Output XML
<DATASET>
<CONSTANT><ApiKey>[Value]</ApiKey></CONSTANT>
<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:
https://api.exacttouch.com/API/mailing/?
type=contact&activity=Update&
data=<DATASET>
<CONSTANT>
<ApiKey> abcde123fghijk456lmno789pqrst </ApiKey></CONSTANT>
<INPUT>
<AddEmail>admin@domainname.com</AddEmail>
<AttributeValues>
<RECORD>
<ID>2</ID>
<Value>hello</Value>
</RECORD>
</AttributeValues>
<ListMember>5</ListMember>
<Userid>cs@domainname.com</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.
Input XML
Output XML
<DATASET>
<CONSTANT>
<ApiKey>[Value]</ApiKey>
</CONSTANT>
<INPUT>
<Emailaddress>[Value]</Emailaddress>
</INPUT>
</DATASET>
<DATASET>
<TYPE>[value]</TYPE>
<OUTPUT><USERID>[value] </USERID></OUTPUT>
</DATASET>
1.
2.
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
Sent [Optional]: The number of mails sent in a particular campaign are shown in the report if
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
Abuse [Optional]: The number of report abuse for the campaign is shown in the report if this
Unsub
[Optional]: The number of unsubscriptions for the campaign are shown in the report if
Bounce
[Optional]: The number of bounces for the campaign are shown in the report if this
10. HardBounce:
11.
12.
13.
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
Entered
[Optional]: The entered date for the campaign is fetched in the reports if this tag
is set to '1'.
18.
SentDate
set to '1'.
[Optional]: The sent date for the campaign is fetched in the reports if this tag is
19.
Scheduled [Optional]: The scheduled date for the campaign is fetched in the reports if this
Size
[Optional]: The size of the campaign( in KB) is fetched in the reports if this tag is set
to '1'.
N OTE : 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
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
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>
<CONSTANT><ApiKey>[Value]</ApiKey></CONSTANT>
<CRITERIA><MsgId>[Value]</MsgId>
<StartDate>[Value]</StartDate>
<EndDate>[Value]</EndDate>
<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><TotalCl
ick>[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.
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>
<Entered>[Value]</Entered>
<SentDate>[Value]</SentDate>
<Size>[Value]</Size>
<Scheduled>[Value]</Scheduled>
<Templates>[Value]</Templates>
<Owner>[Value]</Owner>
<UniqueClickPercentage>[Value]</UniqueClickPercentage>
</RECORD>
</DATASET>
Input XML:
https://api.exacttouch.com/API/mailing/ ?
type=report&activity=summary&data=<DATASET>
<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst </ApiKey>
</CONSTANT>
<CRITERIA><MsgId>2</MsgId><StartDate>12-112014</StartDate><EndDate>25-112014</EndDate><StartTime>13.00</StartTime><EndTime>14.00</EndT
ime></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><Retwee
t>1</Retweet><Fromfield>1</Fromfield><Entered>0</Entered><Sent
Date>0</SentDate><Scheduled>0</Scheduled><Size>0</Size><Lists>
name</Lists><Templates>0</Templates><Owner>0</Owner><OpenPerce
ntage>1</OpenPercentage><TotalClickPercentage>1</TotalClickPer
centage><UniqueClickPercentage>1</UniqueClickPercentage><Total
Click>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
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
Input XML
<DATASET>
<CONSTANT>
<ApiKey>[Value]</ApiKey></CONSTANT><CRITERIA>
<MsgId>[Value]</MsgId>
<StartDate>[Value]</StartDate>
<EndDate>[Value]</EndDate>
<StartTime>[Value]</StartTime>
<EndTime>[Value]</EndTime>
<Attributes>[Value]</Attributes>
<Action>[Value]</Action>
</CRITERIA><INPUT>
<Subject>[Value]</Subject>
<Fromfield>[Value]</Fromfield>
<Entered>[Value]</Entered>
<SentDate>[Value]</SentDate>
<Scheduled>[Value]</Scheduled>
<Size>[Value]</Size>
<Lists>[Value]</Lists>
<Templates>[Value]</Templates>
<Owner>[Value]</Owner>
<NotifyEmail>[Value]</NotifyEmail>
<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>
<TYPE>[value]</TYPE>
<RECORD><Jobid>[Value]</Jobid></RECORD>
< /DATASET>
Input XML:
https://api.exacttouch.com/API/mailing/?
type=report&activity=download&data=<DATASET>
<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>
</CONSTANT><CRITERIA><MsgId>2</MsgId><StartDate>12-112014</StartDate><EndDate>27-112014</EndDate><StartTime>13.00</StartTime><EndTime>14.00</EndT
ime><Attributes>sample</Attributes><Action>Fb_like</Action></C
RITERIA><DOWNLOAD><Merge>1</Merge></DOWNLOAD><INPUT><Subject>
weeklyoffer</Subject><Fromfield>marketing</Fromfield><Entered>
0</Entered><SentDate>27-112014</SentDate><Scheduled>0</Scheduled><Size>4</Size><Lists>13
</Lists><Templates>5</Templates><Owner>0</Owner><NotifyEmail>n
otifyme@domainname.com</NotifyEmail><CallbackUrl>http://mydoma
in.com/track/callback.php</CallbackUrl></INPUT></DATASET>
Output XML:
<DATASET>
<TYPE>success</TYPE>
<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>
<ApiKey>[Value]</ApiKey>
</CONSTANT><CRITERIA>
<StartDate>[Value]</StartDate>
<EndDate>[Value]</EndDate>
</CRITERIA>
<INPUT>
<Abuse>[Value]</Abuse>
<Unsub>[Value]</Unsub>
<Bounce>[Value]</Bounce></INPUT>
</DATASET>
Unsubscribes, Abuse and Bounce counts are provided in the output XML.
Output XML
<RECORD>
<Date>[Value]</Date>
<Unsub>[Value]</Unsub>
<Abuse>[Value]</Abuse>
<Bounce>[Value]</Bounce>
</RECORD>
Top priorit-1
Default priority-2
Least priority-3
These APIs enable you to perform the following activities associated with jobs:
1
1.
2.
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>
<ApiKey>[Value]</ApiKey>
</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>
<JOBID>[Value]</JOBID>
<Status>[Value]</Status>
<Entered>[Value]</Entered>
<Priority>[Value]</Priority>
<NotifyEmail>[Value]</NotifyEmail>
<CallbackUrl>[Value]</CallbackUrl>
</OUTPUT>
</DATASET>
Input XML:
https://api.exacttouch.com/API/mailing/?
type=job&activity=Status&
data=<DATASET>
<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>
</CONSTANT>
<INPUT><JOBID>23</JOBID></INPUT>
</DATASET>
Output XML:
<DATASET>
<TYPE>success</TYPE>
<OUTPUT>
<JOBID>3</JOBID>
<Status>Entered</Status>
<Entered>2014-11-05</Entered>
<Priority>2</Priority>
<NotifyEmail>admin@mydomain.com</NotifyEmail>
<CallbackUrl>http://mydomain.com/track/callback.php</CallbackU
rl>
</OUTPUT>
</DATASET>
[type] :
job
[activity] :Update
Input Parameters:
1.
2.
3.
NotifyEmail: Email address to which you want to send the status of job
4.
Input XML
Output:
<DATASET>
<CONSTANT>
<ApiKey>[Value]</ApiKey>
</CONSTANT>
<INPUT>
<JOBID>[Value]</JOBID>
<NotifyEmail>[Value]</NotifyEmail>
<CallbackUrl>[Value]</CallbackUrl>
<TaskPriority>[Value]</TaskPriority>
</INPUT>
</DATASET>
JOBID: Job ID to be updated.
Output XML
Sample API Call:
<DATASET>
<TYPE>[value]</TYPE>
<OUTPUT><JOBID>[value]</JOBID></OUTPUT>
</DATASET>
4.6.3 Delete
Input XML:
https://api.exacttouch.com/API/mailing/?
type=job&activity=Update&
data=<DATASET>
<CONSTANT>
<ApiKey>abcde123fghijk456lmno789pqrst</ApiKey>
</CONSTANT>
<INPUT><JOBID>34</JOBID>
<NotifyEmail>custcare@domainname.com</NotifyEmail>
<TaskPriority>1</TaskPriority>
</INPUT>
</DATASET>
Output XML:
<DATASET>
<TYPE>success</TYPE>
<OUTPUT><JOBID>34</JOBID></OUTPUT>
</DATASET>
[type]:
job
[activity] :
delete
Input Parameters:
1.
Input XML
Output:
<DATASET>
<CONSTANT>
<ApiKey>[Value]</ApiKey>
</CONSTANT>
<INPUT><JOBID>[Value]</JOBID></INPUT>
</DATASET>
JOBID: Job ID to be removed.
Output XML
<DATASET>
<TYPE>success</TYPE>
<OUTPUT>
<JOBID>Value removed</JOBID>
</OUTPUT>
</DATASET>
https://api.exacttouch.com/API/mailing/?
type=job&activity=Delete&
data=<DATASET>
<CONSTANT><ApiKey>abcde123fghijk456lmno789pqrst </ApiKey>
</CONSTANT>
<INPUT><JOBID>sample id</JOBID>
</INPUT>
</DATASET>
Output XML:
<DATASET>
<TYPE>success</TYPE>
<OUTPUT><JOBID>3</JOBID></OUTPUT>
</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
emmsupport@netcore.co.in.