Service Web Service

Service

Click here for a complete list of operations.

createCampaign2

Create a new email campaign and campaign creatives .
Arguments:

loginEmail: Login Email of Spread.
password: Login Password of Spread.
campaignName: The name of the email campaign.
campaignCreatives: campaignCreatives Array, CampaignCreatives Class includes displayName, fromAddress, replyTo, subject, creativeContent, target and isCampaignDefault.
category: An array of string contains the names of categories added to this email campaign.
interval: Type of email Campaign. -1, send for once only. Non-negetive number, n days after subscribers subscribe.

schedule: The date of when to establish the email campaign.
signature: The signature of the email campaign.
campaignStatus: The status of the email campaign.
return campaignID.

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 /service.asmx HTTP/1.1
Host: service.rspread.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://service.reasonablespread.com/createCampaign2"

<?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>
    <createCampaign2 xmlns="http://service.reasonablespread.com/">
      <loginEmail>string</loginEmail>
      <password>string</password>
      <campaignName>string</campaignName>
      <campaignCreatives>
        <CampaignCreatives>
          <subject>string</subject>
          <displayName>string</displayName>
          <fromAddress>string</fromAddress>
          <replyTo>string</replyTo>
          <creativeContent>string</creativeContent>
          <target>string</target>
          <isCampaignDefault>boolean</isCampaignDefault>
        </CampaignCreatives>
        <CampaignCreatives>
          <subject>string</subject>
          <displayName>string</displayName>
          <fromAddress>string</fromAddress>
          <replyTo>string</replyTo>
          <creativeContent>string</creativeContent>
          <target>string</target>
          <isCampaignDefault>boolean</isCampaignDefault>
        </CampaignCreatives>
      </campaignCreatives>
      <category>
        <string>string</string>
        <string>string</string>
      </category>
      <interval>int</interval>
      <schedule>dateTime</schedule>
      <signature>string</signature>
      <campaignStatus>Deleted or Sent or Draft or Pause or Sending or Waiting or EngineSending or PreApproval or DisApproval or Approved or NRTriggering or Preparing or UploadWaiting or Inexistent</campaignStatus>
    </createCampaign2>
  </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>
    <createCampaign2Response xmlns="http://service.reasonablespread.com/">
      <createCampaign2Result>int</createCampaign2Result>
    </createCampaign2Response>
  </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 /service.asmx HTTP/1.1
Host: service.rspread.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>
    <createCampaign2 xmlns="http://service.reasonablespread.com/">
      <loginEmail>string</loginEmail>
      <password>string</password>
      <campaignName>string</campaignName>
      <campaignCreatives>
        <CampaignCreatives>
          <subject>string</subject>
          <displayName>string</displayName>
          <fromAddress>string</fromAddress>
          <replyTo>string</replyTo>
          <creativeContent>string</creativeContent>
          <target>string</target>
          <isCampaignDefault>boolean</isCampaignDefault>
        </CampaignCreatives>
        <CampaignCreatives>
          <subject>string</subject>
          <displayName>string</displayName>
          <fromAddress>string</fromAddress>
          <replyTo>string</replyTo>
          <creativeContent>string</creativeContent>
          <target>string</target>
          <isCampaignDefault>boolean</isCampaignDefault>
        </CampaignCreatives>
      </campaignCreatives>
      <category>
        <string>string</string>
        <string>string</string>
      </category>
      <interval>int</interval>
      <schedule>dateTime</schedule>
      <signature>string</signature>
      <campaignStatus>Deleted or Sent or Draft or Pause or Sending or Waiting or EngineSending or PreApproval or DisApproval or Approved or NRTriggering or Preparing or UploadWaiting or Inexistent</campaignStatus>
    </createCampaign2>
  </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>
    <createCampaign2Response xmlns="http://service.reasonablespread.com/">
      <createCampaign2Result>int</createCampaign2Result>
    </createCampaign2Response>
  </soap12:Body>
</soap12:Envelope>