Service Web Service

Service

Click here for a complete list of operations.

createCampaign

Create a new email campaign and send it out.
Arguments:

loginEmail: Login Email of Spread.
password: Login Password or API KEY of Spread.
campaignArgs: Campaign Class, includes campaignName, fromEmail, from, subject, content, signature and schedule
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.

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/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://service.reasonablespread.com/">
      <loginEmail>string</loginEmail>
      <password>string</password>
      <campaignArgs>
        <campaignName>string</campaignName>
        <fromEmail>string</fromEmail>
        <from>string</from>
        <subject>string</subject>
        <content>string</content>
        <signature>string</signature>
        <schedule>dateTime</schedule>
      </campaignArgs>
      <category>
        <string>string</string>
        <string>string</string>
      </category>
      <interval>int</interval>
    </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://service.reasonablespread.com/">
      <createCampaignResult>int</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 /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>
    <createCampaign xmlns="http://service.reasonablespread.com/">
      <loginEmail>string</loginEmail>
      <password>string</password>
      <campaignArgs>
        <campaignName>string</campaignName>
        <fromEmail>string</fromEmail>
        <from>string</from>
        <subject>string</subject>
        <content>string</content>
        <signature>string</signature>
        <schedule>dateTime</schedule>
      </campaignArgs>
      <category>
        <string>string</string>
        <string>string</string>
      </category>
      <interval>int</interval>
    </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://service.reasonablespread.com/">
      <createCampaignResult>int</createCampaignResult>
    </createCampaignResponse>
  </soap12:Body>
</soap12:Envelope>