Remove all contacts from address book

The RemoveAllContactsFromAddressBook method removes all contacts in a specified address book.

Removing the contacts will not cause the contact to be suppressed unless you specify this in the request.

Parameters

username	string	This is the username from your API key. It is in the format of an email address and will look similar to apiuser-908709770324@apiconnector.com	required
password	string	This is the password from your API key.	required
addressBookId	int	This is the ID of the addressbook you want to remove contacts from.	required
preventAddressbookResubscribe	boolean	If this is set to true, the contacts will be added to the address book specific suppression list.	optional
totalUnsubscribe	boolean	If this is set to true the contacts will be added to the account suppression list.	optional

Return values

None.

Error responses

ERROR_ADDRESSBOOK_NOT_FOUND
ERROR_APIUSAGE_EXCEEDED
ERROR_INVALID_LOGIN
ERROR_PARAMETER_INVALID
ERROR_SYSTEM_SERVICETEMPORARILYUNAVAILABLE
ERROR_UNKNOWN

Request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/RemoveAllContactsFromAddressBook"

Example of use in C# .NET

/// <summary>
/// This method should be used to remove all contacts in a specified address book. 
/// Removing the contacts will not cause the contact to be suppressed unless
/// you specify this in the request.
/// </summary>
public void RemoveAllContactsFromAddressBook()
{
    const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
    const string password = "password";
    const int addressBookId =1;
 
    Console.WriteLine("RemoveAllContactsFromAddressBook");
    Console.WriteLine("--------------------------------");
 
    // Get an instance to the web reference
    com.apiconnector.API api = new com.apiconnector.API();
 
    try
    {
        // the removed contacts will not be added to the address book suppression list 
        const bool preventAddressbookResubscribe = false;
 
        //the removed contacts will not be added to the account suppression list
        const bool totalUnsubscribe = false;
 
        // remove all of the contacts from the address book, 
        api.RemoveAllContactsFromAddressBook(username, password, addressBookId, preventAddressbookResubscribe, totalUnsubscribe);
 
        // if we are still here - then the command has been completed
        Console.WriteLine("Contacts removed from address book {0}", addressBookId);
    }
    catch (SoapException ex)  // catch any soap issues/errors from the web service
    {
        Console.WriteLine("Error -> {0}", ex.Message);
    }
 
    Console.WriteLine();
}

Sample request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/RemoveAllContactsFromAddressBook"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <RemoveAllContactsFromAddressBook xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <addressBookId>int</addressBookId>
      <preventAddressbookResubscribe>boolean</preventAddressbookResubscribe>
      <totalUnsubscribe>boolean</totalUnsubscribe>
    </RemoveAllContactsFromAddressBook>
  </soap:Body>
</soap:Envelope>

Sample response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <RemoveAllContactsFromAddressBookResponse xmlns="http://apiconnector.com" />
  </soap:Body>
</soap:Envelope>

About the API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates

Remove all contacts from address book

The RemoveAllContactsFromAddressBook method removes all contacts in a specified address book.

Parameters

Return values

Error responses

Request

Example of use in C# .NET

Sample request

Sample response

Get started with dotMailer: