Create and send newsletter

Newsletters collection allows creating and sending newsletter messages. Content can either be sent along with the request or stored on an external source (e.g. FTP server).

Request data format

Data part of request for creating a new newsletter.

Data element children:

Recipients element children:

* Newsletter has to have at least one subscriber list, subscriber segment or seed list specified. Empty recipients element will trigger appropriate error message.

Content element children:

* You may either put content of newsletter inside using Html, Plain and/or AmpHtml elements or specify that content is to be downloaded from external source (such as webpage or FTP server as zipped file with HTML and images) using ContentFromUrl element. If content was not found in either place, an error message will be returned. If there are more than one Html, Plain and/or AmpHtml files only the last file will be the content of message. If you would like to send AMP Html you should provide Html and/or Plain as a fallback version of email.

AMP Html content must contain all needed elements (see examples) and all links must be secure links (like https://)

** It is not possible to have both ContentFromUrl and Attachments elements at the same time.

Note: If you wish to send inline images within your newsletter, using ContentFromUrl method is the only way to do it.

ContentFromUrl element children:

GoogleAnalyticsTags element children:

Note: The remaining tag, "utm_medium" is by default specified as "Email".

Attachment element children:

* Note: For list of MIME types for different files, see: http://en.wikipedia.org/wiki/Internet_media_type
** Note: Binary to Base64 encoding is available in most programming languages. For more information about Base64 encoding, see: http://en.wikipedia.org/wiki/Base64

DeliverySettings element children:

Delivery throttling methods:

Channel element children:

* The sum of percentage for all selected channels must be 100% or an error message will occur. Example configuration could be 2 channels with 30/70 ratio or 3 channels with 25/25/50 ratio. A list of available channels can be found in unit settings, in ExpertSender panel.

UrlIntegrations element children:

Example:

</UrlIntegration>

</UrlIntegration>

</UrlIntegrations>

Response

Method returns ID of created newsletter. ID can be used to retrieve message statistics (see /Api/MessageStatistics) to ascertain newsletters progress.

Response Data element:

Examples

Sending a simple newsletter

Request:

POST https://api.esv2.com/v2/Api/Newsletters HTTP/1.1

Accept-Encoding: gzip,deflate

Content-Type: text/xml;charset=UTF-8

User-Agent: Jakarta Commons-HttpClient/3.1

Host: api.esv2.com

Content-Length: 457

<ApiKey>2OAEcpz0Rwv3Mhc9nTQK</ApiKey>

<Data>

</SubscriberLists>

</Recipients>

<Subject>Hello!</Subject>

<Plain>Hello friend, how are you?</Plain>

</Content>

</Data>

</ApiRequest>

Response:

HTTP/1.1 201 Created

Cache-Control: private

Content-Type: text/xml; charset=utf-8

Server: Microsoft-IIS/7.5

X-AspNetMvc-Version: 3.0

X-AspNet-Version: 4.0.30319

X-Powered-By: ASP.NET

Date: Tue, 27 Mar 2012 13:28:01 GMT

Content-Length: 149

</ApiResponse>

Sending newsletter with content downloaded from external source and full options

Request:

POST https://api.esv2.com/v2/Api/Newsletters HTTP/1.1

Accept-Encoding: gzip,deflate

Content-Type: text/xml;charset=UTF-8

User-Agent: Jakarta Commons-HttpClient/3.1

Host: api.esv2.com

Content-Length: 1727

<ApiKey>2OAEcpz0Rwv3Mhc9nTQK</ApiKey>

<Data>

</SubscriberLists>

</SubscriberSegments>

</SeedLists>

</SuppressionLists>

</Recipients>

<Subject>Hello!</Subject>

<Url>ftp://ftp.domain.com.creative.zip</Url>

<Username>username</Username>

<Password>password</Password>

<FtpAuth>ExplicitTls</FtpAuth>

</ContentFromUrl>

<Campaign>testcampaign</Campaign>

<Source>testsource</Source>

<Content>testcontent</Content>

</GoogleAnalyticsTags>

<Tags>

</Tags>

</Content>

<ThrottlingMethod>Manual</ThrottlingMethod>

</Channel>

</Channel>

</Channels>

</DeliverySettings>

</Data>

</ApiRequest>

Sending newsletter with attachment

Request:

POST https://api.esv2.com/v2/Api/Newsletters HTTP/1.1

Accept-Encoding: gzip,deflate

Content-Type: text/xml;charset=UTF-8

User-Agent: Jakarta Commons-HttpClient/3.1

Host: api.esv2.com

Content-Length: 32566

<Data>

</SubscriberLists>

</Recipients>

<Subject>Hello!</Subject>

<Plain>Hello friend, how are you?</Plain>

<MimeType>application/pdf</MimeType> <Content>JVBERi0xLjUNCiW1tbW1DQoxIDAgb2JqDQo8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFIvTGFu

ZyhwbC1QTCkgL1N0cnVjdFRyZWVSb290IDggMCBSL01hcmtJbmZvPDwvTWFya2VkIHRydWU+Pj4+

DQplbmRvYmoNCjIgMCBvYmoNCjw8L1R5cGUvUGFnZXMvQ291bnQgMS9LaWRzWyAzIDAgUl0gPj4N

CmVuZG9iag0KMyAwIG9iag0KPDwvVHlwZS9QYWdlL1BhcmVudCAyIDAgUi9SZXNvdXJjZXM8PC9G

...

ODlFOENBQTNGMTY5NzFBRTU+XSAvUHJldiA4MjU0MS9YUmVmU3RtIDgyMjcwPj4NCnN0YXJ0eHJl

Zg0KODMwNTcNCiUlRU9G</Content>

</Attachment>

</Attachments>

</Content>

</Data>

</ApiRequest>

Note: Part of long attachment content was cut and "..." was inserted.

Sending newsletter with AMP Html content

Request:

POST https://api.esv2.com/v2/Api/Newsletters HTTP/1.1

Accept-Encoding: gzip,deflate

Content-Type: text/xml;charset=UTF-8

User-Agent: Jakarta Commons-HttpClient/3.1

Host: api.esv2.com

Content-Length: 32566

<Data>

</SubscriberLists>

</Recipients>

<Subject>Hello!</Subject>

<Html>Some fallback HTML code here</Html>

<AmpHtml><![CDATA[

<!doctype html>

<head>

</head>

<body>

Hello, AMP world.

Please use AMP markup if there is such like "amp-img" instead of "img"

<amp-img src="https://sites.google.com/site/expertsenderapiv2/_/rsrc/1530873497175/config/Es- API.png.1530873496983.png"

alt="Welcome"

width="906"

height="132">

</amp-img>

</body>

</html>

]]></AmpHtml>

</Content>

</Data>

</ApiRequest>