{"id":3561,"date":"2023-08-29T19:06:30","date_gmt":"2023-08-29T18:06:30","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=3561"},"modified":"2025-10-03T12:35:31","modified_gmt":"2025-10-03T11:35:31","slug":"create-and-send-newsletter","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/email-messages\/create-and-send-newsletter\/","title":{"rendered":"Create and send newsletter"},"content":{"rendered":"\n

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).<\/p>\n\n\n\n

For this method, all request data should be provided in XML or JSON format. Responses, depending on the format provided, are also generated as XML or JSON data. <\/p>\n\n\n\n

The content type for such a request should be set to text\/xml or application\/json.<\/p>\n\n\n\n

<\/a><\/a>Request data format<\/strong><\/h3>\n\n\n\n

Data part of request for creating a new newsletter.<\/p>\n\n\n\n

Data element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Recipients<\/td>complex<\/td>Newsletter recipients\u2019 information. Required.<\/td><\/tr>
Content<\/td>complex<\/td>Content information. Required.<\/td><\/tr>
DeliverySettings<\/td>complex<\/td>Delivery settings (delivery date, throttling, etc). Optional. If omitted, default delivery settings will be used.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Recipients element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
SubscriberLists<\/td>array[integer]<\/td>Array of SubscriberList elements containing IDs of subscriber lists that newsletter will be sent to. Optional.*<\/td><\/tr>
SubscriberSegments<\/td>array[integer]<\/td>Array of SubscriberSegment elements containing IDs of subscriber segments that newsletter will be sent to. Optional.*<\/td><\/tr>
SeedLists<\/td>array[integer]<\/td>Array of SeedList elements containing IDs of seed lists used during shipment. Optional.*<\/td><\/tr>
SuppressionLists<\/td>array[integer]<\/td>Array of SuppressionList elements containing IDs of suppression lists that will be checked during shipment. Optional.<\/td><\/tr>
ExcludedLists<\/td>array[integer]<\/td>An array of SubscriberList elements containing the IDs of the subscriber lists to which the newsletter will be excluded from mailing. Optional.<\/td><\/tr>
ExcludedSegments<\/td>array[integer]<\/td>An array of SubscriberSegment elements containing the IDs of the subscriber segments to which the newsletter will be excluded from mailing. Optional.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

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

Content element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
FromName<\/td>string<\/td>String put into \u201cFrom:\u201d header. Required.<\/td><\/tr>
FromEmail<\/td>string<\/td>Email put into \u201cFrom:\u201d header. Required.<\/td><\/tr>
ReplyToName<\/td>string<\/td>String put into \u201cReply-To:\u201d header. Optional.<\/td><\/tr>
ReplyToEmail<\/td>string<\/td>Email put into \u201cReply-To:\u201d header. Optional.<\/td><\/tr>
Subject<\/td>string<\/td>Newsletter subject. Required.<\/td><\/tr>
Html<\/td>string<\/td>HTML content of newsletter. The data should be enclosed in CDATA section for XML transport. See examples. Optional.*<\/td><\/tr>
Plain<\/td>string<\/td>Plain text content of newsletter. Optional.*<\/td><\/tr>
AmpHtml<\/td>string<\/td>AMP HTML content of newsletter. The data should be enclosed in CDATA section for XML transport. See examples. Optional.*<\/td><\/tr>
Preheader<\/td>string <\/td>Newsletter preheader. Optional.<\/td><\/tr>
Header<\/td>integer<\/td>ID of header template to use. Optional.<\/td><\/tr>
Footer<\/td>integer<\/td>ID of footer template to use. Optional.<\/td><\/tr>
ContentFromUrl<\/td>complex<\/td>Used if content is not inside XML request but has to be downloaded from external source. Optional.*<\/td><\/tr>
GoogleAnalyticsTags<\/td>complex<\/td>Google Analytics tags used to decorate links inside newsletter\u2019s content. Optional. If omitted, Google Analytics will be disabled for created newsletter.<\/td><\/tr>
CustomUtms<\/td>array[complex]<\/td>Array of CustomUtm elements used to add custom information to URLs in the newsletter. Optional.<\/td><\/tr>
Tags<\/td>array[string]<\/td>List of tags used to mark the newsletter for convenience reasons. Optional.<\/td><\/tr>
Attachments<\/td>complex<\/td>Collection of “Attachment” elements, containing additional attachment data (e.g. encoded PDF files sent with the newsletter). Optional.**<\/td><\/tr>
UrlIntegrations<\/td>complex<\/td>List of IDs of URL integrations that were created in Business unit settings. Optional.<\/td><\/tr>
EnableClickTrack<\/td>boolean<\/td>If set to \u201cfalse\u201d, clicks won\u2019t be tracked. By default set to \u201ctrue\u201d. Optional.<\/td><\/tr>
EnableOpenTrack<\/td>boolean<\/td>If set to \u201cfalse\u201d, opens won\u2019t be tracked. By default set to \u201ctrue\u201d. Optional.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

* 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.<\/p>\n\n\n\n

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

** It is not possible to have both ContentFromUrl and Attachments elements at the same time.<\/p>\n\n\n\n

Note: If you wish to send inline images within your newsletter, using ContentFromUrl method is the only way to do it.<\/p>\n\n\n\n

ContentFromUrl element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Url<\/td>string<\/td>URL address of imported file. Supported protocols are HTTP, HTTPS, FTP, FTPS and SFTP. E.g. ftp:\/\/www.domain.com\/mycreative.zip<\/td><\/tr>
Username<\/td>string<\/td>Username used for authentication. Optional.<\/td><\/tr>
Password<\/td>string<\/td>Password used for authentication. Optional.<\/td><\/tr>
FtpAuth<\/td>string<\/td>Authentication method for secure FTP servers. Optional. Valid values are:
None – FTP server does not support secure authentication (default)
ExplicitTls – Explicit TLS\/SSL authentication
ExplicitSsl – Explicit SSL only authentication
ImplicitSsl – Implicit SSL authentication<\/td><\/tr>
FtpUseActiveMode<\/td>boolean<\/td>If set to “true”, active mode will be used for FTP connections. Default value is “false” – passive connection mode will be used.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

GoogleAnalyticsTags element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Campaign<\/td>string<\/td>Google Analytics tag “utm_campaign”. Optional.<\/td><\/tr>
Source<\/td>string<\/td>Google Analytics tag “utm_source”. Optional.<\/td><\/tr>
Content<\/td>string<\/td>Google Analytics tag “utm_content”. Optional.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Note: The remaining tag, “utm_medium” is by default specified as “Email”.<\/p>\n\n\n\n

CustomUtms element children:<\/p>\n\n\n\n

Element\/attribute<\/strong><\/th>Type<\/strong><\/th>Notes<\/strong><\/th><\/tr><\/thead>
Name<\/td>string<\/td>The name of the custom UTM parameter. Maximum length: 255 characters. The name cannot be empty and must be unique.
Do not reuse names already reserved by Google Analytics (e.g., utm_source, utm_medium, utm_campaign, utm_term, utm_content).<\/td><\/tr>
Value<\/td>string<\/td>The value assigned to the UTM parameter. Maximum length: 255 characters. The value cannot be empty.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Attachment element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
FileName<\/td>string<\/td>Attachment filename. E.g. “infosheet.pdf”. Should be unique (no 2 attachments should have the same filename). Required.<\/td><\/tr>
MimeType<\/td>string<\/td>File type according to MIME standards. E.g. “application\/pdf”. If omitted, default MIME type will be used: “application\/octet-stream”. Optional. MIME type can affect how email attachments are treated in different email clients, so it is advisable to always specify the correct type.*<\/td><\/tr>
Content<\/td>string<\/td>Attachment file content. Must be Base64 encoded.** See example requests. Required.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

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

DeliverySettings element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
DeliveryDate<\/td>dateTime<\/td>Newsletter delivery date. Optional. By default, newsletter will be sent immediately.<\/td><\/tr>
TimeZone<\/td>string<\/td>Time zone used with specified delivery date. Optional. Defaults to standard (unit) settings. List of valid values<\/a>.<\/td><\/tr>
OverrideDeliveryCap<\/td>boolean<\/td>If set to “true”, newsletter will ignore any delivery frequency capping settings. Optional. Default is “false”.<\/td><\/tr>
ThrottlingMethod<\/td>string<\/td>Delivery throttling method. See below for description of different throttling methods. Optional. Default is “None”.<\/td><\/tr>
ManualThrottlingTime<\/td>int<\/td>Time (in hours) of manual delivery throttling. This setting is required if ThrottlingMethod was set to “Manual” and ignored in other cases.<\/td><\/tr>
TimeOptimizationPeriod<\/td>string<\/td>Time of delivery for Sending Time Optimization (STO). This setting is only used if ThrottlingMethod was set to “TimeOptimized” and is ignored in other cases.
Valid values are: “24h” (24 hours – default) and “7d” (7 days).<\/td><\/tr>
Channels<\/td>array[complex]<\/td>Array of Channel elements describing delivery channels. Optional. If omitted, standard (unit) channel settings will be used to deliver the newsletter.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Delivery throttling methods:<\/p>\n\n\n\n

Name<\/th>Behavior<\/th><\/tr><\/thead>
None<\/td>Delivery will not be throttled. Newsletter will be sent as quickly as possible. This is a default method, but not recommended for delivering large volumes.<\/td><\/tr>
Auto<\/td>Automatic throttling. Delivery time will be automatically calculated, depending on number of recipients and unit settings.<\/td><\/tr>
Manual<\/td>Manual throttling. Delivery time is specified manually as a number of hours the whole delivery will take.<\/td><\/tr>
TimeOptimized<\/td>Sending Time Optimization (STO). Date of delivery will be calculated for each subscriber based on their previous performance over the next 24h\/7d.<\/td><\/tr>
TimeTravel<\/td>Time Travel. Date of delivery will be calculated for each subscriber based on their timezone.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Channel element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Ip<\/td>string<\/td>Delivery channel IP address.<\/td><\/tr>
Percentage<\/td>integer<\/td>Portion (%) of emails that will be sent using this delivery channel.*<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

* 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.<\/p>\n\n\n\n

UrlIntegrations element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
ID<\/td>int<\/td>Id number of existing, not deleted integration. Required.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Example:<\/p>\n\n\n\n

<\/path><\/path><\/svg><\/span>
<<\/span>UrlIntegrations<\/span>><\/span><\/span>\n    <\/span><<\/span>UrlIntegration<\/span>><\/span><\/span>\n        <\/span><<\/span>Id<\/span>><\/span>30<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n    <\/span><\/<\/span>UrlIntegration<\/span>><\/span><\/span>\n    <\/span><<\/span>UrlIntegration<\/span>><\/span><\/span>\n        <\/span><<\/span>Id<\/span>><\/span>32<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n    <\/span><\/<\/span>UrlIntegration<\/span>><\/span><\/span>\n<\/<\/span>UrlIntegrations<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Response<\/strong><\/h3>\n\n\n\n
Method returns ID of created newsletter. ID can be used to retrieve message statistics (see \/Api\/MessageStatistics) to ascertain newsletters progress.<\/p>\n\n\n\n
Response Data element:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
(Data element content)<\/td>int<\/td>ID of created newsletter.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Examples<\/strong><\/h3>\n\n\n\n
Sending a simple newsletter<\/strong><\/p>\n\n\n\n
Request in XML format:<\/p>\n\n\n\n