Client.GetCampaigns

Gets a list of all campaigns that have been sent for a client.

Parameters and required information
Return Codes
SOAP 1.1
HTTP GET
HTTP POST

Parameters and required information

Here’s a list of all the parameters you’ll need to pass to the Client.GetCampaigns method. All of the parameters are required unless otherwise noted.

ApiKey
Your API application key. See here for more details.

ClientID
The ID of the client whose campaigns should be returned. See here for more details.

Return Codes

Success

Upon a successful call, this method will return a collection of Campaign objects, each of which consists of the CampaignID, subject, name, sentdate (yyyy-MM-dd hh:mm:ss) and number of recipients for each campaign.

Error

100: Invalid API Key
The API key pass was not valid or has expired.

102: Invalid ClientID
The ClientID value passed in was not valid.

SOAP 1.1

The following is a sample SOAP request and response. The placeholders shown need to be replaced with actual values.

POST /api/api.asmx HTTP/1.1
Host: api.createsend.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.createsend.com/api/Client.GetCampaigns"

<?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>
    <Client.GetCampaigns xmlns="http://api.createsend.com/api/">
      <ApiKey>string</ApiKey>
      <ClientID>string</ClientID>
    </Client.GetCampaigns>
  </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>
    <Client.GetCampaignsResponse xmlns="http://api.createsend.com/api/">
      <Client.GetCampaignsResult>
         <Campaign>
          <CampaignID>string</CampaignID>
          <Subject>string</Subject>
          <Name>string</Name>
          <SentDate>string</SentDate>
          <TotalRecipients>int</TotalRecipients>
        </Campaign>
        <Campaign>
          <CampaignID>string</CampaignID>
          <Subject>string</Subject>
          <Name>string</Name>
          <SentDate>string</SentDate>
          <TotalRecipients>int</TotalRecipients>
        </Campaign>
      </Client.GetCampaignsResult>
    </Client.GetCampaignsResponse>
  </soap:Body>
</soap:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /api/api.asmx/Client.GetCampaigns?ApiKey=string&ClientID=string HTTP/1.1
Host: api.createsend.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<anyType d1p1:type="ArrayOfCampaign">
  <Campaign>
    <CampaignID>string</CampaignID>
    <Subject>string</Subject>
    <Name>string</Name>
    <SentDate>string</SentDate>
    <TotalRecipients>int</TotalRecipients>
  </Campaign>
  <Campaign>
    <CampaignID>string</CampaignID>
    <Subject>string</Subject>
    <Name>string</Name>
    <SentDate>string</SentDate>
    <TotalRecipients>int</TotalRecipients>
  </Campaign>
</anyType>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /api/api.asmx/Campaign.GetCampaigns HTTP/1.1
Host: api.createsend.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

ApiKey=string&ClientID=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<anyType d1p1:type="ArrayOfCampaign">
  <Campaign>
    <CampaignID>string</CampaignID>
    <Subject>string</Subject>
    <Name>string</Name>
    <SentDate>string</SentDate>
    <TotalRecipients>int</TotalRecipients>
  </Campaign>
  <Campaign>
    <CampaignID>string</CampaignID>
    <Subject>string</Subject>
    <Name>string</Name>
    <SentDate>string</SentDate>
    <TotalRecipients>int</TotalRecipients>
  </Campaign>
</anyType>

API Documentation