API Web Service

API

Click here for a complete list of operations.

AddContactsToAddressBookWithProgress

Bulk creates, or bulk updates, contacts. Import format can either be CSV or Excel. Must include one column called "Email". Any other columns will attempt to map to your custom data fields. The returned token (a GUID) can be used to query import progress. Use this method to stay within your API limits.

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/AddContactsToAddressBookWithProgress"

<?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>
    <AddContactsToAddressBookWithProgress xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <addressbookID>int</addressbookID>
      <data>base64Binary</data>
      <dataType>CSV or XLS</dataType>
    </AddContactsToAddressBookWithProgress>
  </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>
    <AddContactsToAddressBookWithProgressResponse xmlns="http://apiconnector.com">
      <AddContactsToAddressBookWithProgressResult>guid</AddContactsToAddressBookWithProgressResult>
    </AddContactsToAddressBookWithProgressResponse>
  </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>
    <AddContactsToAddressBookWithProgress xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <addressbookID>int</addressbookID>
      <data>base64Binary</data>
      <dataType>CSV or XLS</dataType>
    </AddContactsToAddressBookWithProgress>
  </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>
    <AddContactsToAddressBookWithProgressResponse xmlns="http://apiconnector.com">
      <AddContactsToAddressBookWithProgressResult>guid</AddContactsToAddressBookWithProgressResult>
    </AddContactsToAddressBookWithProgressResponse>
  </soap12:Body>
</soap12:Envelope>