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

SmsMmsNewsletters collection allows creating and sending SMS\/MMS newsletter messages.<\/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 od 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>
Sender<\/td>string<\/td>Name of SMS\/MMS gateway that was created in Business unit settings. Required.<\/td><\/tr>
CampaignDescription<\/td>string<\/td>Campaign description. Required.<\/td><\/tr>
Plain<\/td>string<\/td>Plain text content of newsletter. Required.<\/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>
EnableClickTrack<\/td>boolean<\/td>If set to \u201cfalse\u201d, clicks won\u2019t be tracked. By default set to \u201ctrue\u201d. Optional.<\/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 “SMS”.<\/p>\n\n\n\n

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

Element\/attribute<\/th>Type<\/th>Notes<\/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

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><\/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><\/tbody><\/table><\/figure>\n\n\n\n

* Note: The minimum throttling is 60 messages per minute. Longer throttling will be automatically adjusted.<\/p>\n\n\n\n

<\/a><\/a>Respons<\/strong>e<\/strong><\/h3>\n\n\n\n

Method returns ID of created newsletter. ID can be used to pause or resume newsletters with status “InProgress” (see Pause or resume newsletter (SMS)).<\/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

Example<\/strong><\/h3>\n\n\n\n

Sending a simple newsletter<\/strong><\/p>\n\n\n\n

Request:<\/p>\n\n\n\n