listUnsubscribeContacts
public static integer listUnsubscribeContacts(string token, string listID, array contacts)
Unsubscribe the contacts from the given contact list.
Section
Contact List Related Methods

Parameters
string tokenA valid token for your account. To generate a token, use the login method.
string listIDThe contact list ID in which to unsubscrib contacts. To get all the contact lists, use the listGet method.
array contactsThe string array containing the contact details.

Returns
integerReturns the total number of contacts which are active in the list.


Examples
download example code
xmlrpc_listUnsubscribeContacts.php


  1. <?php
  2. /**
  3. This Example shows how to authenticate a user using XML-RPC.
  4. Note that we are using the PEAR XML-RPC client and recommend others do as well.
  5. **/
  6. require_once 'XML/RPC2/Client.php';
  7. require_once 'inc/config.php';
  8. $client = XML_RPC2_Client::create($apiURL);
  9. $token = $client->login($apiLogin, $apiPassword);
  10.  
  11. /**
  12. Fetch the latest contact list, so we can retrieve the contact list ID.
  13. **/
  14. $contactList = $client->listGet($token, "", 1, 1, "", "");
  15. $listID = $contactList[0]['id'];
  16.  
  17. /**
  18. Prepare the data to unsubscribe.
  19. **/
  20. $rec[0] = "user1@___.com";
  21. $rec[1] = "user2@___.com";
  22.  
  23. $active = $client->listUnsubscribeContacts($token, $listID, $rec);
  24.  
  25. echo $active . " active records in the list.";
  26. ?>