api


Click here for a complete list of operations.

Campaign.Create

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/api.asmx HTTP/1.1
Host: uuapi.createsend.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.createsend.com/api/Campaign.Create"

<?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>
    <Campaign.Create xmlns="http://api.createsend.com/api/">
      <ApiKey>string</ApiKey>
      <ClientID>string</ClientID>
      <CampaignName>string</CampaignName>
      <CampaignSubject>string</CampaignSubject>
      <FromName>string</FromName>
      <FromEmail>string</FromEmail>
      <ReplyTo>string</ReplyTo>
      <HtmlUrl>string</HtmlUrl>
      <TextUrl>string</TextUrl>
      <SubscriberListIDs>
        <string>string</string>
        <string>string</string>
      </SubscriberListIDs>
      <ListSegments>
        <List>
          <ListID>string</ListID>
          <Name>string</Name>
        </List>
        <List>
          <ListID>string</ListID>
          <Name>string</Name>
        </List>
      </ListSegments>
    </Campaign.Create>
  </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>
    <Campaign.CreateResponse xmlns="http://api.createsend.com/api/">
      <Campaign.CreateResult />
    </Campaign.CreateResponse>
  </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/api.asmx HTTP/1.1
Host: uuapi.createsend.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>
    <Campaign.Create xmlns="http://api.createsend.com/api/">
      <ApiKey>string</ApiKey>
      <ClientID>string</ClientID>
      <CampaignName>string</CampaignName>
      <CampaignSubject>string</CampaignSubject>
      <FromName>string</FromName>
      <FromEmail>string</FromEmail>
      <ReplyTo>string</ReplyTo>
      <HtmlUrl>string</HtmlUrl>
      <TextUrl>string</TextUrl>
      <SubscriberListIDs>
        <string>string</string>
        <string>string</string>
      </SubscriberListIDs>
      <ListSegments>
        <List>
          <ListID>string</ListID>
          <Name>string</Name>
        </List>
        <List>
          <ListID>string</ListID>
          <Name>string</Name>
        </List>
      </ListSegments>
    </Campaign.Create>
  </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>
    <Campaign.CreateResponse xmlns="http://api.createsend.com/api/">
      <Campaign.CreateResult />
    </Campaign.CreateResponse>
  </soap12:Body>
</soap12:Envelope>