Service


Click here for a complete list of operations.

UpdateCampaignStatus

Create a new email campaign and campaign creatives .
Arguments:

loginEmail: Login Email of Spread.
APIKey: API Key of Spread.
campaignID: The ID of the email campaign.
campaignStatus: The status of the email campaign.
return true if succeed.

Remarks: If only the campaign is in "Sending" or "Waiting" can be updated to "Pause", Or in "Pause" can be updated to "Waiting".

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
loginEmail:
APIKey:
campaignID:
campaignStatus:

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/UpdateCampaignStatus"

<?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>
    <UpdateCampaignStatus xmlns="http://service.reasonablespread.com/">
      <loginEmail>string</loginEmail>
      <APIKey>string</APIKey>
      <campaignID>string</campaignID>
      <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>
    </UpdateCampaignStatus>
  </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>
    <UpdateCampaignStatusResponse xmlns="http://service.reasonablespread.com/">
      <UpdateCampaignStatusResult>boolean</UpdateCampaignStatusResult>
    </UpdateCampaignStatusResponse>
  </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>
    <UpdateCampaignStatus xmlns="http://service.reasonablespread.com/">
      <loginEmail>string</loginEmail>
      <APIKey>string</APIKey>
      <campaignID>string</campaignID>
      <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>
    </UpdateCampaignStatus>
  </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>
    <UpdateCampaignStatusResponse xmlns="http://service.reasonablespread.com/">
      <UpdateCampaignStatusResult>boolean</UpdateCampaignStatusResult>
    </UpdateCampaignStatusResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /service.asmx/UpdateCampaignStatus?loginEmail=string&APIKey=string&campaignID=string&campaignStatus=string HTTP/1.1
Host: service.rspread.com

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

<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://service.reasonablespread.com/">boolean</boolean>

HTTP POST

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

POST /service.asmx/UpdateCampaignStatus HTTP/1.1
Host: service.rspread.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

loginEmail=string&APIKey=string&campaignID=string&campaignStatus=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://service.reasonablespread.com/">boolean</boolean>