EmailSvc Web Service

EmailSvc

Click here for a complete list of operations.

SendEmailFromTemplateForCampaignSegment

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: simplicitycrm.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://services.simplicitycrm.com/dataintegration/emailsend/SendEmailFromTemplateForCampaignSegment"

<?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>
    <SendEmailFromTemplateForCampaignSegment xmlns="http://services.simplicitycrm.com/dataintegration/emailsend">
      <Token>string</Token>
      <CampaignSegment_RSN>string</CampaignSegment_RSN>
      <EmailTemplateName>string</EmailTemplateName>
      <MergeEntities>
        <CampaignListEntity>
          <EntityType>string</EntityType>
          <EntityRSN>string</EntityRSN>
        </CampaignListEntity>
        <CampaignListEntity>
          <EntityType>string</EntityType>
          <EntityRSN>string</EntityRSN>
        </CampaignListEntity>
      </MergeEntities>
      <LabelCodes>
        <MergeLabelCode>
          <LabelCode>string</LabelCode>
          <LabelCodeName>string</LabelCodeName>
        </MergeLabelCode>
        <MergeLabelCode>
          <LabelCode>string</LabelCode>
          <LabelCodeName>string</LabelCodeName>
        </MergeLabelCode>
      </LabelCodes>
      <MergeFields>
        <MergeField>
          <FieldName>string</FieldName>
          <FieldValue>string</FieldValue>
        </MergeField>
        <MergeField>
          <FieldName>string</FieldName>
          <FieldValue>string</FieldValue>
        </MergeField>
      </MergeFields>
      <LogAgainstEntities>
        <CampaignListEntity>
          <EntityType>string</EntityType>
          <EntityRSN>string</EntityRSN>
        </CampaignListEntity>
        <CampaignListEntity>
          <EntityType>string</EntityType>
          <EntityRSN>string</EntityRSN>
        </CampaignListEntity>
      </LogAgainstEntities>
    </SendEmailFromTemplateForCampaignSegment>
  </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>
    <SendEmailFromTemplateForCampaignSegmentResponse xmlns="http://services.simplicitycrm.com/dataintegration/emailsend">
      <SendEmailFromTemplateForCampaignSegmentResult>
        <ErrorCode>int</ErrorCode>
        <EmailID>long</EmailID>
        <MessageID>string</MessageID>
        <CampaignListRSN>string</CampaignListRSN>
      </SendEmailFromTemplateForCampaignSegmentResult>
    </SendEmailFromTemplateForCampaignSegmentResponse>
  </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: 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>
    <SendEmailFromTemplateForCampaignSegment xmlns="http://services.simplicitycrm.com/dataintegration/emailsend">
      <Token>string</Token>
      <CampaignSegment_RSN>string</CampaignSegment_RSN>
      <EmailTemplateName>string</EmailTemplateName>
      <MergeEntities>
        <CampaignListEntity>
          <EntityType>string</EntityType>
          <EntityRSN>string</EntityRSN>
        </CampaignListEntity>
        <CampaignListEntity>
          <EntityType>string</EntityType>
          <EntityRSN>string</EntityRSN>
        </CampaignListEntity>
      </MergeEntities>
      <LabelCodes>
        <MergeLabelCode>
          <LabelCode>string</LabelCode>
          <LabelCodeName>string</LabelCodeName>
        </MergeLabelCode>
        <MergeLabelCode>
          <LabelCode>string</LabelCode>
          <LabelCodeName>string</LabelCodeName>
        </MergeLabelCode>
      </LabelCodes>
      <MergeFields>
        <MergeField>
          <FieldName>string</FieldName>
          <FieldValue>string</FieldValue>
        </MergeField>
        <MergeField>
          <FieldName>string</FieldName>
          <FieldValue>string</FieldValue>
        </MergeField>
      </MergeFields>
      <LogAgainstEntities>
        <CampaignListEntity>
          <EntityType>string</EntityType>
          <EntityRSN>string</EntityRSN>
        </CampaignListEntity>
        <CampaignListEntity>
          <EntityType>string</EntityType>
          <EntityRSN>string</EntityRSN>
        </CampaignListEntity>
      </LogAgainstEntities>
    </SendEmailFromTemplateForCampaignSegment>
  </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>
    <SendEmailFromTemplateForCampaignSegmentResponse xmlns="http://services.simplicitycrm.com/dataintegration/emailsend">
      <SendEmailFromTemplateForCampaignSegmentResult>
        <ErrorCode>int</ErrorCode>
        <EmailID>long</EmailID>
        <MessageID>string</MessageID>
        <CampaignListRSN>string</CampaignListRSN>
      </SendEmailFromTemplateForCampaignSegmentResult>
    </SendEmailFromTemplateForCampaignSegmentResponse>
  </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/SendEmailFromTemplateForCampaignSegment HTTP/1.1
Host: simplicitycrm.com
Content-Type: application/json; charset=utf-8
Content-Length: length
Authorization: Token string

{
  "CampaignSegment_RSN":string,
  "EmailTemplateName":string,
  "MergeEntities":[
    {
      "EntityType":string,
      "EntityRSN":string,
    },
    {
      "EntityType":string,
      "EntityRSN":string,
    },
  ],
  "LabelCodes":[
    {
      "LabelCode":string,
      "LabelCodeName":string,
    },
    {
      "LabelCode":string,
      "LabelCodeName":string,
    },
  ],
  "MergeFields":[
    {
      "FieldName":string,
      "FieldValue":string,
    },
    {
      "FieldName":string,
      "FieldValue":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,
},