MessagingService


Click here for a complete list of operations.

SendCampaignToCustomers

Send campaign to customers

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 /Messaging/MessagingService.asmx HTTP/1.1
Host: webapi.mymarketing.co.il
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/SendCampaignToCustomers"

<?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:Header>
    <AuthHeader xmlns="http://tempuri.org/">
      <Username>string</Username>
      <Password>string</Password>
      <Token>string</Token>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <SendCampaignToCustomers xmlns="http://tempuri.org/">
      <webCampaign>
        <Subject>string</Subject>
        <From>
          <FromName>string</FromName>
          <FromEmail>string</FromEmail>
        </From>
        <ExternalMessageId>string</ExternalMessageId>
        <BodyParts>
          <BodyPart>
            <BodyPartEncoding>string</BodyPartEncoding>
            <BodyPartFormat>HTML or Text</BodyPartFormat>
            <Body>string</Body>
          </BodyPart>
          <BodyPart>
            <BodyPartEncoding>string</BodyPartEncoding>
            <BodyPartFormat>HTML or Text</BodyPartFormat>
            <Body>string</Body>
          </BodyPart>
        </BodyParts>
        <UserPlaceholders>boolean</UserPlaceholders>
        <AddStatistics>boolean</AddStatistics>
        <AddAdvertisement>boolean</AddAdvertisement>
        <SignMessage>boolean</SignMessage>
        <AddUnsubscribeLink>boolean</AddUnsubscribeLink>
        <LanguageId>int</LanguageId>
        <MailinglistId>int</MailinglistId>
        <FormId>int</FormId>
        <AddPrintButton>boolean</AddPrintButton>
        <Note>string</Note>
        <Name>string</Name>
        <IsABTestingCampaign>boolean</IsABTestingCampaign>
        <IsPreviewCampaign>boolean</IsPreviewCampaign>
        <SubAccountId>int</SubAccountId>
        <MailinglistName>string</MailinglistName>
      </webCampaign>
      <webCustomers>
        <WebCustomer>
          <Id>int</Id>
          <City>string</City>
          <Email>string</Email>
          <Fax>string</Fax>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <Phone1>string</Phone1>
          <Phone2>string</Phone2>
          <Street>string</Street>
          <ZipCode>string</ZipCode>
          <Birthday>string</Birthday>
          <Anniversary>string</Anniversary>
          <Ext1>string</Ext1>
          <Ext2>string</Ext2>
          <Ext3>string</Ext3>
          <Ext4>string</Ext4>
          <Ext5>string</Ext5>
          <Ext6>string</Ext6>
          <Ext23>string</Ext23>
          <EncryptedExt1>string</EncryptedExt1>
          <EncryptedExt2>string</EncryptedExt2>
          <EncryptedExt3>string</EncryptedExt3>
          <EncryptedExt4>string</EncryptedExt4>
          <EventGuid>guid</EventGuid>
          <DontSentToKafka>boolean</DontSentToKafka>
        </WebCustomer>
        <WebCustomer>
          <Id>int</Id>
          <City>string</City>
          <Email>string</Email>
          <Fax>string</Fax>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <Phone1>string</Phone1>
          <Phone2>string</Phone2>
          <Street>string</Street>
          <ZipCode>string</ZipCode>
          <Birthday>string</Birthday>
          <Anniversary>string</Anniversary>
          <Ext1>string</Ext1>
          <Ext2>string</Ext2>
          <Ext3>string</Ext3>
          <Ext4>string</Ext4>
          <Ext5>string</Ext5>
          <Ext6>string</Ext6>
          <Ext23>string</Ext23>
          <EncryptedExt1>string</EncryptedExt1>
          <EncryptedExt2>string</EncryptedExt2>
          <EncryptedExt3>string</EncryptedExt3>
          <EncryptedExt4>string</EncryptedExt4>
          <EventGuid>guid</EventGuid>
          <DontSentToKafka>boolean</DontSentToKafka>
        </WebCustomer>
      </webCustomers>
    </SendCampaignToCustomers>
  </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>
    <SendCampaignToCustomersResponse xmlns="http://tempuri.org/">
      <SendCampaignToCustomersResult>int</SendCampaignToCustomersResult>
    </SendCampaignToCustomersResponse>
  </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 /Messaging/MessagingService.asmx HTTP/1.1
Host: webapi.mymarketing.co.il
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:Header>
    <AuthHeader xmlns="http://tempuri.org/">
      <Username>string</Username>
      <Password>string</Password>
      <Token>string</Token>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <SendCampaignToCustomers xmlns="http://tempuri.org/">
      <webCampaign>
        <Subject>string</Subject>
        <From>
          <FromName>string</FromName>
          <FromEmail>string</FromEmail>
        </From>
        <ExternalMessageId>string</ExternalMessageId>
        <BodyParts>
          <BodyPart>
            <BodyPartEncoding>string</BodyPartEncoding>
            <BodyPartFormat>HTML or Text</BodyPartFormat>
            <Body>string</Body>
          </BodyPart>
          <BodyPart>
            <BodyPartEncoding>string</BodyPartEncoding>
            <BodyPartFormat>HTML or Text</BodyPartFormat>
            <Body>string</Body>
          </BodyPart>
        </BodyParts>
        <UserPlaceholders>boolean</UserPlaceholders>
        <AddStatistics>boolean</AddStatistics>
        <AddAdvertisement>boolean</AddAdvertisement>
        <SignMessage>boolean</SignMessage>
        <AddUnsubscribeLink>boolean</AddUnsubscribeLink>
        <LanguageId>int</LanguageId>
        <MailinglistId>int</MailinglistId>
        <FormId>int</FormId>
        <AddPrintButton>boolean</AddPrintButton>
        <Note>string</Note>
        <Name>string</Name>
        <IsABTestingCampaign>boolean</IsABTestingCampaign>
        <IsPreviewCampaign>boolean</IsPreviewCampaign>
        <SubAccountId>int</SubAccountId>
        <MailinglistName>string</MailinglistName>
      </webCampaign>
      <webCustomers>
        <WebCustomer>
          <Id>int</Id>
          <City>string</City>
          <Email>string</Email>
          <Fax>string</Fax>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <Phone1>string</Phone1>
          <Phone2>string</Phone2>
          <Street>string</Street>
          <ZipCode>string</ZipCode>
          <Birthday>string</Birthday>
          <Anniversary>string</Anniversary>
          <Ext1>string</Ext1>
          <Ext2>string</Ext2>
          <Ext3>string</Ext3>
          <Ext4>string</Ext4>
          <Ext5>string</Ext5>
          <Ext6>string</Ext6>
          <Ext23>string</Ext23>
          <EncryptedExt1>string</EncryptedExt1>
          <EncryptedExt2>string</EncryptedExt2>
          <EncryptedExt3>string</EncryptedExt3>
          <EncryptedExt4>string</EncryptedExt4>
          <EventGuid>guid</EventGuid>
          <DontSentToKafka>boolean</DontSentToKafka>
        </WebCustomer>
        <WebCustomer>
          <Id>int</Id>
          <City>string</City>
          <Email>string</Email>
          <Fax>string</Fax>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <Phone1>string</Phone1>
          <Phone2>string</Phone2>
          <Street>string</Street>
          <ZipCode>string</ZipCode>
          <Birthday>string</Birthday>
          <Anniversary>string</Anniversary>
          <Ext1>string</Ext1>
          <Ext2>string</Ext2>
          <Ext3>string</Ext3>
          <Ext4>string</Ext4>
          <Ext5>string</Ext5>
          <Ext6>string</Ext6>
          <Ext23>string</Ext23>
          <EncryptedExt1>string</EncryptedExt1>
          <EncryptedExt2>string</EncryptedExt2>
          <EncryptedExt3>string</EncryptedExt3>
          <EncryptedExt4>string</EncryptedExt4>
          <EventGuid>guid</EventGuid>
          <DontSentToKafka>boolean</DontSentToKafka>
        </WebCustomer>
      </webCustomers>
    </SendCampaignToCustomers>
  </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>
    <SendCampaignToCustomersResponse xmlns="http://tempuri.org/">
      <SendCampaignToCustomersResult>int</SendCampaignToCustomersResult>
    </SendCampaignToCustomersResponse>
  </soap12:Body>
</soap12:Envelope>