API


Click here for a complete list of operations.

ListCampaigns

Lists all campaigns for the current account. If you have over 500 campaigns, please use ListCampaigns2 instead. Please note that only the basic campaign data will be returned (not the content).

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

<?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>
    <ListCampaigns xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
    </ListCampaigns>
  </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>
    <ListCampaignsResponse xmlns="http://apiconnector.com">
      <ListCampaignsResult>
        <APICampaign>
          <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>
        </APICampaign>
        <APICampaign>
          <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>
        </APICampaign>
      </ListCampaignsResult>
    </ListCampaignsResponse>
  </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.dotmailer.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>
    <ListCampaigns xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
    </ListCampaigns>
  </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>
    <ListCampaignsResponse xmlns="http://apiconnector.com">
      <ListCampaignsResult>
        <APICampaign>
          <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>
        </APICampaign>
        <APICampaign>
          <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>
        </APICampaign>
      </ListCampaignsResult>
    </ListCampaignsResponse>
  </soap12:Body>
</soap12:Envelope>