ResourcesAPI documentation

mailkit.email.unsubscribe.getstatus

Function mailkit.email.unsubscribe.getstatus is used to get information about unsubscribe status of recipient.

API call example:

XML

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.email.unsubscribe.getstatus</methodName>
  <params>
    <param>
      <value>
        <int>client_id</int>
      </value>
    </param>
    <param>
      <value>
        <string>client_md5</string>
      </value>
    </param>
    <param>
      <value>
        <int>email_id</int>
      </value>
    </param>
    <param>
      <value>
        <int>ID_agency_customer</int>
      </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.

email_id * = may contain ID of e-mail address, (returned by mailkit.mailinglist.adduser), or e-mail address. If an email address is provided a list of all found records will be returned.

ID_agency_customer = ID of agency customer (version Mailkit Agency only)

* required value

Successful call response:

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <string>FALSE</string>
      </value>
    </param>
  </params>
</methodResponse>
		

Values

FALSE = e-mail address is not unsubscribed

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <string>TRUE</string>
      </value>
    </param>
  </params>
</methodResponse>
		

TRUE = e-mail address is unsubscribed

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <array>
          <data>
            <value>
              <struct>
                <member>
                  <name>UNSUBSCRIBE</name>
                  <value>
                    <string>TRUE</string>
                  </value>
                </member>
                <member>
                  <name>ID_AGENCY_CUSTOMER</name>
                  <value>
                    <i4>0</i4>
                  </value>
                </member>
                <member>
                  <name>NAME</name>
                  <value>
                    <string>Novinky</string>
                  </value>
                </member>
                <member>
                  <name>DESCRIPTION</name>
                  <value>
                    <string>Informace o novinkách a aktualizacích.</string>
                  </value>
                </member>
                <member>
                  <name>ID_UNSUBSCRIBE_GROUP</name>
                  <value>
                    <i4>14</i4>
                  </value>
                </member>
              </struct>
            </value>
          </data>
        </array>
      </value>
    </param>
  </params>
</methodResponse>
		

UNSUBSCRIBE = possible values:

  • TRUE = e-mail address is unsubscribed
  • FALSE = e-mail address is not unsubscribed

ID_AGENCY_CUSTOMER = ID of agency customer.

NAME = name of unsubscribe group

DESCRIPTION = description of unsubscribe group

ID_UNSUBSCRIBE_GROUP = ID of unsubscribe group