Newsletters collection allows creating and sending Web Push newsletter messages.<\/p>\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 Recipients element children:<\/p>\n\n\n\n *Web Push Newsletter has to have at least one subscriber list or subscriber segment.<\/p>\n\n\n\n Content element children:<\/p>\n\n\n\n Action1 and Action2 element children:<\/p>\n\n\n\n GoogleAnalyticsTags element children:<\/p>\n\n\n\n Note: The remaining tag, “utm_medium” is by default specified as “WebPush”.<\/p>\n\n\n\n CustomUtms element children:<\/p>\n\n\n\n UrlIntegrations element children:<\/p>\n\n\n\n Example:<\/p>\n\n\n\nElement\/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 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> 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 Element\/attribute<\/th> Type<\/th> Notes<\/th><\/tr><\/thead> Subject<\/td> string<\/td> Web Push Newsletter subject. Required.<\/td><\/tr> Body<\/td> string<\/td> Web Push Newsletter body. Required.<\/td><\/tr> Link<\/td> string <\/td> Web Push Newsletter link. Required.<\/td><\/tr> BigImageFromBase64<\/td> complex<\/td> Web Push Newsletter big image. Works only on Chrome. Optional.<\/td><\/tr> BigImageFromUrl<\/td> string<\/td> Web Push Newsletter big image. Works only on Chrome. You can enter the address of the image that will be downloaded. Acceptable JPEG, PNG extensions. Max size of image is 200KB. Optional.<\/td><\/tr> IconFromBase64<\/td> complex<\/td> Web Push Newsletter icon. Optional but required for open tracking.<\/td><\/tr> IconFromUrl<\/td> string<\/td> Web Push Newsletter icon. Optional but required for open tracking. You can enter the address of the image that will be downloaded. Acceptable JPEG, PNG extensions. Max size of image is 200KB.<\/td><\/tr> Action1<\/td> complex <\/td> Web Push Newsletter Action 1 button. Optional.<\/td><\/tr> Action2<\/td> complex<\/td> Web Push Newsletter Action 2 button. 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. Optional.<\/td><\/tr> CustomUtms<\/td> array[complex]<\/td> Array of CustomUtm elements used to add custom information to URLs in 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> RequireInteraction<\/td> boolean<\/td> The User must click or dismiss the notification. By default set to \u201ctrue\u201d. 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 Element\/attribute<\/th> Type<\/th> Notes<\/th><\/tr><\/thead> Title<\/td> string<\/td> Web Push Action button title. Required.<\/td><\/tr> Url<\/td> string <\/td> Web Push Action button Url. Required.<\/td><\/tr> IconFromBase64<\/td> complex<\/td> Web Push Newsletter icon. Optional but required for open tracking.<\/td><\/tr> IconFromUrl<\/td> string<\/td> Web Push Action button icon. Optional. You can enter the address of the image that will be downloaded. Acceptable JPEG, PNG extensions. Max size of image is 200KB<\/td><\/tr><\/tbody><\/table><\/figure>\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 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 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