ResourcesAPI documentation

mailkit.mailinglist.delete

Function mailkit.mailinglist.delete is used to delete mailing list or to delete all recipients in mailing list.

API call example:

XML

<?xml version="1.0"?>
<methodCall>
<methodName>mailkit.mailinglist.delete</methodName>
 <params>
  <param>
   <value>
    <int>client_id</int>
   </value>
  </param>
  <param>
   <value>
    <string>client_md5</string>
   </value>
  </param>
  <param>
   <value>
    <int>ID_mailing_list</int>
   </value>
  </param>
  <param>
   <value>
    <boolean>FALSE/TRUE</boolean>
   </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.

ID_mailing_list * = ID of mailing list

FALSE/TRUE

  • TRUE = all recipients in the mailing list will be deleted. The mailing list will remain.
  • FALSE (default value) = the mailing list will be deleted.

 

* required value

Successful call response:

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
 <params>
  <param>
   <value>
    <struct>
     <member>
      <name>data</name>
      <value>
       <string>OK</string>
      </value>
     </member>
    </struct>
   </value>
  </param>
 </params>
</methodResponse>
		

Values

data = OK = the mailing list was successfully deleted / all recipients in the mailing list were successfully deleted.

Unsuccessful call response:

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
 <params>
  <param>
   <value>
    <string>Missing ID of mailing list</string>
   </value>
  </param>
 </params>
</methodResponse>
		

Values

Missing ID of mailing list

ID of mailing list is missing or ID of mailing list is invalid.