API Web Service

API

Click here for a complete list of operations.

AddContactToAddressBook

Adds a contact to a given address book

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

<?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>
    <AddContactToAddressBook xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <contact>
        <ID>int</ID>
        <Email>string</Email>
        <AudienceType>Unknown or B2C or B2B or B2M</AudienceType>
        <DataFields>
          <Keys>
            <string>string</string>
            <string>string</string>
          </Keys>
          <Values>
            <anyType />
            <anyType />
          </Values>
        </DataFields>
        <OptInType>Unknown or Single or Double or VerifiedDouble</OptInType>
        <EmailType>PlainText or Html</EmailType>
        <Notes>string</Notes>
      </contact>
      <addressbookId>int</addressbookId>
    </AddContactToAddressBook>
  </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>
    <AddContactToAddressBookResponse xmlns="http://apiconnector.com">
      <AddContactToAddressBookResult>
        <ID>int</ID>
        <Email>string</Email>
        <AudienceType>Unknown or B2C or B2B or B2M</AudienceType>
        <DataFields>
          <Keys>
            <string>string</string>
            <string>string</string>
          </Keys>
          <Values>
            <anyType />
            <anyType />
          </Values>
        </DataFields>
        <OptInType>Unknown or Single or Double or VerifiedDouble</OptInType>
        <EmailType>PlainText or Html</EmailType>
        <Notes>string</Notes>
      </AddContactToAddressBookResult>
    </AddContactToAddressBookResponse>
  </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>
    <AddContactToAddressBook xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <contact>
        <ID>int</ID>
        <Email>string</Email>
        <AudienceType>Unknown or B2C or B2B or B2M</AudienceType>
        <DataFields>
          <Keys>
            <string>string</string>
            <string>string</string>
          </Keys>
          <Values>
            <anyType />
            <anyType />
          </Values>
        </DataFields>
        <OptInType>Unknown or Single or Double or VerifiedDouble</OptInType>
        <EmailType>PlainText or Html</EmailType>
        <Notes>string</Notes>
      </contact>
      <addressbookId>int</addressbookId>
    </AddContactToAddressBook>
  </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>
    <AddContactToAddressBookResponse xmlns="http://apiconnector.com">
      <AddContactToAddressBookResult>
        <ID>int</ID>
        <Email>string</Email>
        <AudienceType>Unknown or B2C or B2B or B2M</AudienceType>
        <DataFields>
          <Keys>
            <string>string</string>
            <string>string</string>
          </Keys>
          <Values>
            <anyType />
            <anyType />
          </Values>
        </DataFields>
        <OptInType>Unknown or Single or Double or VerifiedDouble</OptInType>
        <EmailType>PlainText or Html</EmailType>
        <Notes>string</Notes>
      </AddContactToAddressBookResult>
    </AddContactToAddressBookResponse>
  </soap12:Body>
</soap12:Envelope>