Now that you know what we need to create your new list, let's create it!
Quick list creation
|Description||Create a new list|
|JSON request (example)|
|JSON response (example)|
|Paging and filtering (example)|
Advanced list creation
As you have seen in the response of the previous section, a list has many parameters that during creation you can inherit from a specified list or a default table. But sometimes you could have to create a list configuring not mandatory (like a description) or technical (like the maximum newsletter size) parameters. To get more in-depth, the following table shows the optional fields.
|Description||String||Additional details about what the list is used for.|
|Phone||String||The company's phone number|
|PostalCode||String||The company's postal code|
|StateOrProvince||String||The company's state or province|
The list's time zone. Please use one of the TimeZoneCode codes provided by the method Get List of Time Zone codes.
|SmsSenderName||String||Default sender name for text messages. It can be a phone number (e.g. +393351234567) or a string (up to 11 chars, |
only letters and number). Please note that in some country, like Italy, some restrictions on SMS senders apply.
Use MailUp admin console to verify if the specified sender is subject to limitations in some countries.
|DefaultPrefix||String||Default international prefix for mobile numbers (e.g. "0039" for Italy and "001" for United States)|
|SendConfirmSms||Boolean||True when welcome SMS has to be sent for any new subscriber on SMS channel|
|Charset||String||Text charset (see a list of Supported Charsets)|
|Format||String||Format of emails to be sent with this list ("html" or "text")|
|MultipartText||Boolean||Flag to automatically generate a text version of the message at sending stage|
|KBMax||Integer||Message size beyond which a warning is generated. Suggested value = 100|
|NotifyEmail||String||Email address for unsubscribe notifications. Each time a recipient unsubscribes, an email will be sent to this address.|
|OptoutType||Integer||Optout settings that apply when a recipient unsubscribe (0: One-click unsubscribe, 1: , 2: 3: Confirmed unsubscribe with options, 4: Confirmed unsubscribe with Preference Center)|
|MultiOptoutList||String||Detail of the list IDs which will be viewed by the user in case of multiple optout (e.g. 1,2,3 etc.). Applies only when optout_type=2|
|SendEmailOptout||Boolean||When true a "goodbye email" is sent to recipient that unsubscribe|
|SubscribedEmail||Boolean||True when welcome email has to be sent for any new subscriber (it works only when double optin is implemented)|
|BouncedEmail||String||Address for error messages|
|FrontendForm||Boolean||Enable hosted subscription forms, which you can view and edit under Settings > List settings > List Building Tools.|
|Public||Boolean||Flag indicating if the list is visible in the public web library (if you set public=true the created list will be available in|
|ScopeCode||Integer||select here which type of messages you are sending from this list:|
|TrackOnOpened||Boolean||True when link tracking has to be enabled at list level|
|ConversionlabTrackCode||String||Code for tracking via conversionlab|
It allows the integration between the list and third-party services (CRM, analytics).
|Disclaimer||String||Heading added to the messages in the list|
|HeaderListUnsubscriber||String||Heading "LIST-UNSUBSCRIBE" added to the messages in the list. Suggested value = "<[listunsubscribe]>,<[mailto_uns]>"|
|HeaderXAbuse||String||Heading "X-ABUSE" added to the messages in the list. Suggested value = "Please report abuse here: http://[host]/p"|
Old api method