MessagingService


Click here for a complete list of operations.

SendCampaignToEmails

Send campaign to emails

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

<?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>
    <SendCampaignToEmails 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>
      <emails>
        <string>string</string>
        <string>string</string>
      </emails>
    </SendCampaignToEmails>
  </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>
    <SendCampaignToEmailsResponse xmlns="http://tempuri.org/">
      <SendCampaignToEmailsResult>int</SendCampaignToEmailsResult>
    </SendCampaignToEmailsResponse>
  </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>
    <SendCampaignToEmails 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>
      <emails>
        <string>string</string>
        <string>string</string>
      </emails>
    </SendCampaignToEmails>
  </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>
    <SendCampaignToEmailsResponse xmlns="http://tempuri.org/">
      <SendCampaignToEmailsResult>int</SendCampaignToEmailsResult>
    </SendCampaignToEmailsResponse>
  </soap12:Body>
</soap12:Envelope>