API Web Service

API

Click here for a complete list of operations.

SendCampaignToAddressBooks

Sends a specified campaign to one or more address books at a specified time. Leave the address book array empty to send to All Contacts.

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: r1-api.dotdigital.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/SendCampaignToAddressBooks"

<?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>
    <SendCampaignToAddressBooks xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <campaignId>int</campaignId>
      <addressBookIds>
        <int>int</int>
        <int>int</int>
      </addressBookIds>
      <sendDate>dateTime</sendDate>
    </SendCampaignToAddressBooks>
  </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>
    <SendCampaignToAddressBooksResponse 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: r1-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>
    <SendCampaignToAddressBooks xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <campaignId>int</campaignId>
      <addressBookIds>
        <int>int</int>
        <int>int</int>
      </addressBookIds>
      <sendDate>dateTime</sendDate>
    </SendCampaignToAddressBooks>
  </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>
    <SendCampaignToAddressBooksResponse xmlns="http://apiconnector.com" />
  </soap12:Body>
</soap12:Envelope>