ResourcesAPI documentation

mailkit.email.move

Function mailkit.email.move is used to move recipient to the another mailing list.

API call example:

XML

<?xml version="1.0"?>
<methodCall>
  <methodName>mailkit.email.move</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_mailing_list</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* = ID of e-mail address, (returned by mailkit.mailinglist.adduser)

ID_mailing_list = ID of mailing list to where will be the recipient moved.

* required value

Successful call response:

XML

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

Values

1 = e-mail was successfully moved to the another mailing list

Unsuccessful call response:

XML

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

Values

0 = e-mail was not moved (wrong e-mail or e-mail ID)