API call example:
JSON
{
"function":"mailkit.mailinglist.unsubscribed",
"id":"client_id",
"md5":"client_md5",
"parameters":{
"range_from":"YYYY-MM-DD"
}
}
XML
<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
<methodName>mailkit.mailinglist.unsubscribed</methodName>
<params>
<param>
<value>
<int>client_id</int>
</value>
</param>
<param>
<value>
<string>client_md5</string>
</value>
</param>
<param>
<value>
<string>range_from</string>
</value>
</param>
</params>
</methodCall>
Values
client_id * = client ID can be found in your Mailkit account's menu Profile/Integration.
client_md5 * = MD5 code can be found in your Mailkit account's menu Profile/Integration.
range_from = range of requested data. Start date formated as YYYY-MM-DD. The end date is the time of function call.
* required value
Successful call response:
JSON
[
{
"DATE":"2015-10-23 15:18:58",
"ID_UNSUBSCRIBE_GROUP":"",
"EMAIL":"mail@example.eu"
},
{
"DATE":"2015-10-25 11:35:12",
"ID_UNSUBSCRIBE_GROUP":"",
"EMAIL":"+420777123456"
}
]
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<array>
<data>
<value>
<struct>
<member>
<name>DATE</name>
<value>
<string>2015-05-14 15:30:42</string>
</value>
</member>
<member>
<name>ID_UNSUBSCRIBE_GROUP</name>
<value>
<i4>27,29,35</i4>
</value>
</member>
<member>
<name>EMAIL</name>
<value>
<string>mail1@mail1.cz</string>
</value>
</member>
</struct>
</value>
<value>
<struct>
<member>
<name>DATE</name>
<value>
<string>2015-06-02 12:23:02</string>
</value>
</member>
<member>
<name>ID_UNSUBSCRIBE_GROUP</name>
<value>
<string></string>
</value>
</member>
<member>
<name>EMAIL</name>
<value>
<string>+420777123456</string>
</value>
</member>
</struct>
</value>
</data>
</array>
</value>
</param>
</params>
</methodResponse>
Values
DATE = date and time of unsubscribe
ID_UNSUBSCRIBE_GROUP = ID unsubscribe group / groups from which the recipient unsubscribed. If the recipient doesn't belong to any groups and has completely unsubscribed the value will be empty.
EMAIL = email address/mobile phone number of the unsubscribed recipient
Unsuccessful call response:
JSON
{}
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<string></string>
</value>
</param>
</params>
</methodResponse>
If the API request fails, the API returns an empty response.
