WinnerSettings<\/td> complex<\/td> A\/B test winner settings. Required.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\nRecipients element children:<\/p>\n\n\n\nElement\/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
Contents element children:<\/p>\n\n\n\nElement\/attribute<\/strong><\/td>Type<\/strong><\/td>Description<\/strong><\/td><\/tr>Content<\/td> complex<\/td> Newsletter content version. Required.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\nThe Contents collection must contain from 1 to 5 elements.<\/p>\n\n\n\n
Content element children:<\/p>\n\n\n\nElement\/attribute<\/strong><\/td>Type<\/strong><\/td>Description<\/strong><\/td><\/tr>ContentFromUrl<\/td> complex<\/td> Information about content to load from a remote server. Optional.<\/td><\/tr> FromName<\/td> string<\/td> Sender name. Required.<\/td><\/tr> FromEmail<\/td> string<\/td> Sender email address. Required.<\/td><\/tr> ReplyToName<\/td> string<\/td> Reply-to name. Optional.<\/td><\/tr> ReplyToEmail<\/td> string<\/td> Reply-to email address. Optional.<\/td><\/tr> Subject<\/td> string<\/td> Message subject. Required.<\/td><\/tr> Preheader<\/td> string<\/td> Message preheader. Optional.<\/td><\/tr> Header<\/td> int<\/td> Header template ID. Optional.<\/td><\/tr> Footer<\/td> int<\/td> Footer template ID. Optional.<\/td><\/tr> Html<\/td> string<\/td> HTML content. Optional.<\/td><\/tr> Plain<\/td> string<\/td> Plain text content. Optional.<\/td><\/tr> AmpHtml<\/td> string<\/td> AMP HTML content. Optional.<\/td><\/tr> GoogleAnalyticsTags<\/td> complex<\/td> Google Analytics tags. Optional.<\/td><\/tr> CustomUtms<\/td> array[complex]<\/td> Custom UTM parameters. Optional.<\/td><\/tr> Tags<\/td> array[string]<\/td> Message tags. Optional.<\/td><\/tr> UrlIntegrations<\/td> complex<\/td> URL integrations. Optional.<\/td><\/tr> Attachments<\/td> complex<\/td> Message attachments. Optional.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\nContentFromUrl element children:<\/p>\n\n\n\nElement\/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: 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\nGoogleAnalyticsTags element children:<\/p>\n\n\n\nElement\/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\nNote: The remaining tag, “utm_medium” is by default specified as “Email”.<\/p>\n\n\n\n
CustomUtms element children:<\/p>\n\n\n\nElement\/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. 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\nUrlIntegrations element children:<\/p>\n\n\n\nElement\/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\nAttachment element children:<\/p>\n\n\n\nElement\/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\nDeliverySettings element children:<\/p>\n\n\n\nElement\/attribute<\/th> Type<\/th> Notes<\/th><\/tr><\/thead> DeliveryDates<\/td> complex<\/td> Delivery dates for the A\/B test. Optional. If not specified, current date and time is used.<\/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. 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> EnableOpenTrack<\/td> boolean<\/td> Indicates whether open tracking is enabled. Optional. Default value: true.<\/td><\/tr> EnableClickTrack<\/td> boolean<\/td> Indicates whether click tracking is enabled. Optional. Default value: true.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\nDeliveryDates element children:<\/p>\n\n\n\nElement\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>Date<\/td> datetime<\/td> Delivery date for the A\/B test. Required.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\nFor an A\/B test by content<\/strong>:<\/p>\n\n\n\n\nContents must contain more than one content version,<\/li>\n\n\n\n DeliveryDates must contain exactly one date,<\/li>\n\n\n\n if DeliveryDates is not provided, current date and time is used.<\/li>\n<\/ul>\n\n\n\nFor an A\/B test by date<\/strong>:<\/p>\n\n\n\n\nContents must contain exactly one content version,<\/li>\n\n\n\n DeliveryDates must contain from 2 to 5 dates,<\/li>\n\n\n\n WinnerPickMethod must be set to Manual.<\/li>\n<\/ul>\n\n\n\nChannels element children:<\/p>\n\n\n\nElement\/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\nThe sum of all Percentage values must equal 100.<\/p>\n\n\n\n
WinnerSetting element children:<\/p>\n\n\n\nElement\/attribute<\/strong><\/td>Type<\/strong><\/td>Notes<\/strong><\/td><\/tr>TestGroupsSize<\/td> integer<\/td> Percentage of recipients assigned to test groups. Required.<\/td><\/tr> WinnerPickMethod<\/td> string<\/td> Method used to select the winning version. Available options are listed later in the documentation. Required.<\/td><\/tr> SendWinnerAfterHours<\/td> integer<\/td> Number of hours after which the winning version should be sent. Used for winner selection methods other than Manual. Optional.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\nThrottlingMethod element children:<\/p>\n\n\n\nName<\/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><\/tbody><\/table><\/figure>\n\n\n\nTimeTravel is not supported for A\/B tests.<\/p>\n\n\n\n
WinnerPickMethod element children:<\/p>\n\n\n\nName<\/strong><\/td>Behavior<\/strong><\/td><\/tr>OpenRate<\/td> Winning version is selected based on open rate.<\/td><\/tr> ClickRate<\/td> Winning version is selected based on click rate.<\/td><\/tr> GoalRate<\/td> Winning version is selected based on goal rate.<\/td><\/tr> GoalValue<\/td> Winning version is selected based on goal value.<\/td><\/tr> Manual<\/td> Winning version is selected manually.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n