ResourcesAPI documentation

mailkit.mailinglist.unsubscribed

Function mailkit.mailinglist.unsubscribed returns a list of all unsubscribed recipients.

API call example:

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 / API settings.

client_md5 * = MD5 code can be found in your Mailkit account's menu Profile / Integration / API settings.

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:

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>0</i4>
                  </value>
                </member>
                <member>
                  <name>EMAIL</name>
                  <value>
                    <string>mail1@mail1.com</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>27,29,35</string>
                  </value>
                </member>
                <member>
                  <name>EMAIL</name>
                  <value>
                    <string>mail2@mail2.com</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 of the unsubscribed recipient