ResourcesAPI documentation

mailkit.email.unsubscribe

Function mailkit.email.unsubscribe is used to unsubscribe recipient.

API call example:

XML

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.email.unsubscribe</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_send_message</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. When this function is called the email specified will be marked as unsubscribed and won't be available for any future campaign deliveries.

ID_send_message = ID of a specific campaign delivery (Optional). When provided the unsubscribe will be recorded for the specific delivery.

* required value

Successful call response:

XML

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

Values

ID of unsubscribed e-mail

Unsuccessful call response:

XML

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

Values

unknown email = e-mail address or ID e-mail was not found in the account