EmailSvc

Click here for a complete list of operations.

SendEmailForCampaign

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 /SingleView/Common/EmailSvc.asmx HTTP/1.1
Host: www.simplicitycrm.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://services.simplicitycrm.com/dataintegration/emailsend/SendEmailForCampaign"

<?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>
    <SendEmailForCampaign xmlns="http://services.simplicitycrm.com/dataintegration/emailsend">
      <Token>string</Token>
      <CampaignName>string</CampaignName>
      <CampaignSegmentName>string</CampaignSegmentName>
      <Email>
        <To>string</To>
        <Cc>string</Cc>
        <Bcc>string</Bcc>
        <From>string</From>
        <ReplyTo>string</ReplyTo>
        <Subject>string</Subject>
        <BodyText>string</BodyText>
        <BodyHTML>string</BodyHTML>
        <QueueFilter>string</QueueFilter>
      </Email>
      <LogAgainstEntities>
        <CampaignListEntity>
          <EntityType>string</EntityType>
          <EntityRSN>string</EntityRSN>
        </CampaignListEntity>
        <CampaignListEntity>
          <EntityType>string</EntityType>
          <EntityRSN>string</EntityRSN>
        </CampaignListEntity>
      </LogAgainstEntities>
    </SendEmailForCampaign>
  </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>
    <SendEmailForCampaignResponse xmlns="http://services.simplicitycrm.com/dataintegration/emailsend">
      <SendEmailForCampaignResult>
        <ErrorCode>int</ErrorCode>
        <EmailID>long</EmailID>
        <MessageID>string</MessageID>
        <CampaignListRSN>string</CampaignListRSN>
      </SendEmailForCampaignResult>
    </SendEmailForCampaignResponse>
  </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 /SingleView/Common/EmailSvc.asmx HTTP/1.1
Host: www.simplicitycrm.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>
    <SendEmailForCampaign xmlns="http://services.simplicitycrm.com/dataintegration/emailsend">
      <Token>string</Token>
      <CampaignName>string</CampaignName>
      <CampaignSegmentName>string</CampaignSegmentName>
      <Email>
        <To>string</To>
        <Cc>string</Cc>
        <Bcc>string</Bcc>
        <From>string</From>
        <ReplyTo>string</ReplyTo>
        <Subject>string</Subject>
        <BodyText>string</BodyText>
        <BodyHTML>string</BodyHTML>
        <QueueFilter>string</QueueFilter>
      </Email>
      <LogAgainstEntities>
        <CampaignListEntity>
          <EntityType>string</EntityType>
          <EntityRSN>string</EntityRSN>
        </CampaignListEntity>
        <CampaignListEntity>
          <EntityType>string</EntityType>
          <EntityRSN>string</EntityRSN>
        </CampaignListEntity>
      </LogAgainstEntities>
    </SendEmailForCampaign>
  </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>
    <SendEmailForCampaignResponse xmlns="http://services.simplicitycrm.com/dataintegration/emailsend">
      <SendEmailForCampaignResult>
        <ErrorCode>int</ErrorCode>
        <EmailID>long</EmailID>
        <MessageID>string</MessageID>
        <CampaignListRSN>string</CampaignListRSN>
      </SendEmailForCampaignResult>
    </SendEmailForCampaignResponse>
  </soap12:Body>
</soap12:Envelope>

JSON

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

POST /SingleView/api/Common/EmailSvc/SendEmailForCampaign HTTP/1.1
Host: www.simplicitycrm.com
Content-Type: application/json; charset=utf-8
Content-Length: length
Authorization: Token string

{
  "CampaignName":string,
  "CampaignSegmentName":string,
  "Email":{
    "To":string,
    "Cc":string,
    "Bcc":string,
    "From":string,
    "ReplyTo":string,
    "Subject":string,
    "BodyText":string,
    "BodyHTML":string,
    "QueueFilter":string,
  },
  "LogAgainstEntities":[
    {
      "EntityType":string,
      "EntityRSN":string,
    },
    {
      "EntityType":string,
      "EntityRSN":string,
    },
  ],
},

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

{
  "ErrorCode":int,
  "EmailID":long,
  "MessageID":string,
  "CampaignListRSN":string,
},