API


Click here for a complete list of operations.

CreateCampaign

Creates a campaign. Will be validated before saving.

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

<?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>
    <CreateCampaign xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <campaign>
        <FromName>string</FromName>
        <HTMLContent>string</HTMLContent>
        <Id>int</Id>
        <Name>string</Name>
        <PlaintextContent>string</PlaintextContent>
        <ReplyAction>Unset or WebMailForward or Webmail or Delete</ReplyAction>
        <ReplyToAddress>string</ReplyToAddress>
        <Status>NotSet or Unsent or Sending or Sent or Paused or Cancelled or RequiresSystemApproval or RequiresSMSApproval or RequiresWorkflowApproval or Triggered</Status>
        <Subject>string</Subject>
      </campaign>
    </CreateCampaign>
  </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>
    <CreateCampaignResponse xmlns="http://apiconnector.com">
      <CreateCampaignResult>
        <FromName>string</FromName>
        <HTMLContent>string</HTMLContent>
        <Id>int</Id>
        <Name>string</Name>
        <PlaintextContent>string</PlaintextContent>
        <ReplyAction>Unset or WebMailForward or Webmail or Delete</ReplyAction>
        <ReplyToAddress>string</ReplyToAddress>
        <Status>NotSet or Unsent or Sending or Sent or Paused or Cancelled or RequiresSystemApproval or RequiresSMSApproval or RequiresWorkflowApproval or Triggered</Status>
        <Subject>string</Subject>
      </CreateCampaignResult>
    </CreateCampaignResponse>
  </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>
    <CreateCampaign xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <campaign>
        <FromName>string</FromName>
        <HTMLContent>string</HTMLContent>
        <Id>int</Id>
        <Name>string</Name>
        <PlaintextContent>string</PlaintextContent>
        <ReplyAction>Unset or WebMailForward or Webmail or Delete</ReplyAction>
        <ReplyToAddress>string</ReplyToAddress>
        <Status>NotSet or Unsent or Sending or Sent or Paused or Cancelled or RequiresSystemApproval or RequiresSMSApproval or RequiresWorkflowApproval or Triggered</Status>
        <Subject>string</Subject>
      </campaign>
    </CreateCampaign>
  </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>
    <CreateCampaignResponse xmlns="http://apiconnector.com">
      <CreateCampaignResult>
        <FromName>string</FromName>
        <HTMLContent>string</HTMLContent>
        <Id>int</Id>
        <Name>string</Name>
        <PlaintextContent>string</PlaintextContent>
        <ReplyAction>Unset or WebMailForward or Webmail or Delete</ReplyAction>
        <ReplyToAddress>string</ReplyToAddress>
        <Status>NotSet or Unsent or Sending or Sent or Paused or Cancelled or RequiresSystemApproval or RequiresSMSApproval or RequiresWorkflowApproval or Triggered</Status>
        <Subject>string</Subject>
      </CreateCampaignResult>
    </CreateCampaignResponse>
  </soap12:Body>
</soap12:Envelope>