mailkit.email.move

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

API call example:

JSON 

{  
   "function":"mailkit.email.move",
   "id":"client_id",
   "md5":"client_md5",
   "parameters":{  
      "ID_email":987654321,
      "ID_user_list":123456
   }
}

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.
client_md5* = MD5 code can be found in your Mailkit account's menu Profile/Integration.
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:

JSON 

{  
   "ID_user_list_source":"112233",
   "email":"email",
   "ID_email":"123456789",
   "move_response":123456789,
   "ID_email_source": 987654321,
   "error_status":"0",
   "ID_user_list":"123456"
}

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 (XML)

ID_user_list_source = ID of the recipient list from which the recipient was moved
ID_user_list = ID of the recipient list to which the email was moved​​​​​​​
email = email address
ID_email = email ID in the recipient list to which the recipient was moved​​​​​​​
ID_email_source = email ID in the source recipient list (from which the recipient was moved)​​​​​​​
move_response = move status
error_status = error status

Unsuccessful call response:

JSON 

{
    "error_status": 1,
    "error": "Invalid ID_email or email"
}

XML 

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

Values

0 = email was not moved (an invalid email or ID_email was entered, or the given email already exists in the list (for XML))

error_status = error status
error = description of the error status