Lists collection allows creating new subscriber lists. Created lists can then be used to import subscribers or add them manually using API, panel or any other available method.<\/p>\n\n\n\n
Data part of request for creating a new subscribers list.<\/p>\n\n\n\n
Data element children:<\/p>\n\n\n\n GeneralSettings element children:<\/p>\n\n\n\n Note: Language and charset list is a subject to change. Ask ExpertSender Support if your preferred language\/charset could be supported.<\/p>\n\n\n\n AddressSettings element children:<\/p>\n\n\n\n AddressSettings element children:<\/p>\n\n\n\n DomainSettings element children:<\/p>\n\n\n\n ConfirmationEmail element children:<\/p>\n\n\n\n *For maximum accessibility, confirmation emails are required to have both HTML and plain text contents. This is a special case. There is no such requirement for regular emails such as newsletters.<\/p>\n\n\n\n Method returns ID of created subscriber list. ID can be used e.g. to schedule import to this list.<\/p>\n\n\n\n Response Data element:<\/p>\n\n\n\n Creating new subscribers list with default options<\/strong><\/p>\n\n\n\n Request:<\/p>\n\n\n\nElement\/attribute<\/th> Type<\/th> Notes<\/th><\/tr><\/thead> GeneralSettings<\/td> complex<\/td> Element containing basic list settings. Required.<\/td><\/tr> AddressSettings<\/td> complex<\/td> Address settings for list. Optional.<\/td><\/tr> SubscriberSettings<\/td> complex<\/td> Additional settings concerning subscribers. Optional.<\/td><\/tr> DomainSettings<\/td> complex<\/td> Domain settings. Optional.<\/td><\/tr> ConfirmationEmail<\/td> complex<\/td> Confirmation email settings for double opt-in lists. Optional. If not specified, default confirmation email will be used for the list.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n Element\/attribute<\/th> Type<\/th> Notes<\/th><\/tr><\/thead> IsSeedList<\/td> boolean<\/td> Flag indicating if created list will be a regular or seed list. Optional. Default is “false” (regular list).<\/td><\/tr> Name<\/td> string<\/td> List name. Max 50 characters. Required.<\/td><\/tr> FriendlyName<\/td> string<\/td> List name visible for subscribers. Max 50 characters. Optional.<\/td><\/tr> Description<\/td> string<\/td> Internal list description. Optional.<\/td><\/tr> Language<\/td> string<\/td> List language. Affects default footers, date\/number formats etc. Default value is “en-US”. Optional. See below for available list languages.<\/td><\/tr> OptInMode<\/td> string<\/td> Opt-in mode. Default value is “SingleOptIn”. Can be specified as “DoubleOptIn” for lists that require sending confirmation email.<\/td><\/tr> Charset<\/td> string<\/td> Charset (codepage) for emails. Optional. Default is “UTF-8”. See below for all supported charsets.<\/td><\/tr> SubscriptionConfirmPageUrl<\/td> string<\/td> URL subscribers are redirected to after subscribing to the list. Optional. Default is empty (no redirect).<\/td><\/tr> SubscriptionThankYouPageUrl<\/td> string<\/td> URL subscribers are redirected to after confirming subscription to the list. Optional. Default is empty (no redirect).<\/td><\/tr> RemovalPageUrl<\/td> string<\/td> URL subscribers are redirected to after unsubscribing from the list. Optional. Default is empty (no redirect).<\/td><\/tr> PreferencesChangeUrl<\/td> string<\/td> URL subscribers are redirected to after changing their preferences on “Preference Center” page. Optional. Default is empty (no redirect). <\/td><\/tr> DeleteAfterDays<\/td> int<\/td> Parameter for a temporary list. Specifies the number of days after which the list will be deleted. Maximum: 90 days. Optional.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n Supported list languages<\/th><\/tr><\/thead> en-US<\/td><\/tr> pl-PL<\/td><\/tr> ru-RU<\/td><\/tr> zh-Hans<\/td><\/tr> pt-BR<\/td><\/tr> es-ES<\/td><\/tr> it-IT<\/td><\/tr> fr-FR<\/td><\/tr> de-DE<\/td><\/tr> cs-CZ<\/td><\/tr> nl-NL<\/td><\/tr> hu-HU<\/td><\/tr> ro-RO<\/td><\/tr> sk-SK<\/td><\/tr> lt-LT<\/td><\/tr> lv-LV<\/td><\/tr> et-EE<\/td><\/tr> hr-HR<\/td><\/tr> uk-UA<\/td><\/tr> sl-SI<\/td><\/tr> bg-BG<\/td><\/tr> el-GR<\/td><\/tr> sr-Latn<\/td><\/tr> ja-JP<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n Supported list charsets<\/th><\/tr><\/thead> UTF-8<\/td><\/tr> ISO-8859-1<\/td><\/tr> ISO-8859-2<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n Element\/attribute<\/th> Type<\/th> Notes<\/th><\/tr><\/thead> Company<\/td> string<\/td> Company name. Optional.<\/td><\/tr> Address<\/td> string<\/td> Address, first line. Optional.<\/td><\/tr> Address2<\/td> string<\/td> Address, second line. Optional.<\/td><\/tr> City<\/td> string<\/td> City. Optional.<\/td><\/tr> ZipPostalCode<\/td> string<\/td> ZIP or postal code. Optional.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n Element\/attribute<\/th> Type<\/th> Notes<\/th><\/tr><\/thead> DefaultSubscriberName<\/td> string<\/td> String used as a default subscriber name if no name is available in the database.<\/td><\/tr> DefaultSubscriberFirstname<\/td> string<\/td> String used as a default subscriber firstname.<\/td><\/tr> DefaultSubscriberLastname<\/td> string<\/td> String used as a default subscriber lastname.<\/td><\/tr> FrequencyCappingTimeEmail<\/td> integer<\/td> Minimal amount of hours between sending two emails to subscribers. Optional. Default is 0 (no limit).<\/td><\/tr> FrequencyCappingTimeSmsMms<\/td> integer<\/td> Minimal amount of hours between sending two SMS\/MMS messages to subscribers. Optional. Default is 0 (no limit).<\/td><\/tr> DisableStandardMessageFooter<\/td> boolean<\/td> If set to “true” (note the lowercase!), emails to the list will be sent without default message footer. Optional. Default is “false”.<\/td><\/tr> DisableListUnsubscribeHeader<\/td> boolean<\/td> If set to “true” (note the lowercase!), emails to the list will be sent without “List-Unsubscribe:” header. Optional. Default is “false”.<\/td><\/tr> AskBeforeUnsubscribing<\/td> boolean<\/td> If set to “true” (note the lowercase!), subscribers will be asked to confirm unsubscribing from the list (disables “one-click unsubscribe”). Optional. Default is “false”.<\/td><\/tr> HideListInPreferenceCenter<\/td> boolean<\/td> If set to “true” (note the lowercase!), list will not be showed in Preference Center.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n Element\/attribute<\/th> Type<\/th> Notes<\/th><\/tr><\/thead> ClickTrackingDomain<\/td> string<\/td> Custom domain that will be used in links in emails sent to the list. Optional. Defaults to standard (unit) settings.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n Element\/attribute<\/th> Type<\/th> Notes<\/th><\/tr><\/thead> FromName<\/td> string<\/td> String that will be used in “From:” header of confirmation emails. Required.<\/td><\/tr> FromEmail<\/td> string<\/td> Email that will be used in “From:” header of confirmation emails. Required.<\/td><\/tr> Subject<\/td> string<\/td> Confirmation email subject. Required.<\/td><\/tr> Html<\/td> string<\/td> HTML content of confirmation email. The data should be enclosed in CDATA section for XML transport. See examples. Required.*<\/td><\/tr> Plain<\/td> string<\/td> Plain text content of confirmation email. Required.*<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n <\/a><\/a>Re<\/strong>sponse<\/strong><\/h2>\n\n\n\n
Element\/attribute<\/th> Type<\/th> Notes<\/th><\/tr><\/thead> (Data element content)<\/td> int<\/td> ID of created list.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n Examples<\/strong><\/h2>\n\n\n\n