Creates and activates a workflow message<\/p>\n\n\n\n
Data part of request for creating a new workflow message.<\/p>\n\n\n\n
Data element children:<\/strong><\/p>\n\n\n\n Recipients element children:<\/strong><\/p>\n\n\n\n Content element children:<\/strong><\/p>\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 GoogleAnalyticsTags element children:<\/p>\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 Attachment element children:<\/p>\n\n\n\n * Note: For list of MIME types for different files, see: http:\/\/en.wikipedia.org\/wiki\/Internet_media_type<\/a> 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> Message’s recipients\u2019 information. Required.<\/td><\/tr> Content<\/td> complex<\/td> Content information. Required.<\/td><\/tr> DeliverySettings<\/td> complex<\/td> Delivery settings (channels, bcc, 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> SuppressionLists<\/td> array[integer]<\/td> Array of SuppressionList elements containing IDs of suppression lists that will be checked during shipment. Optional.<\/td><\/tr><\/tbody><\/table><\/figure>\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 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 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<\/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 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: 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\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\n