API Web Service

API

Click here for a complete list of operations.

RemoveAllContactsFromAddressBook

Removes all contacts from a given address book. The parameters 'preventAddressbookResubscribe' and 'totalUnsubscribe' are deprecated and do nothing.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /api.asmx HTTP/1.1
Host: api.dotdigital.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>

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>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /api.asmx HTTP/1.1
Host: api.dotdigital.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <RemoveAllContactsFromAddressBook xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <addressBookId>int</addressBookId>
      <preventAddressbookResubscribe>boolean</preventAddressbookResubscribe>
      <totalUnsubscribe>boolean</totalUnsubscribe>
    </RemoveAllContactsFromAddressBook>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <RemoveAllContactsFromAddressBookResponse xmlns="http://apiconnector.com" />
  </soap12:Body>
</soap12:Envelope>