Now the procedure to create a new list is easier and coherent with the information you provide creating it using your MailUp platform. We suggest to use the following new method to create a new list, but if you prefer you can continue using the old method that you find in the expand box below.
Happy list creation!
What are mandatory fields?
...
!
Now that you know what we need to create your new list, let's create it!
Quick list creation
This is the minimum set of fields that are required to create a MailUp list using REST API. Please note that
you always have to specify the so called "mandatory sender details" (see below)
at least one between "IdSetting" and "UseDefaultSettings" has to be included in the request data
you can also add any of the other optional fields (see the full list below)
Expand
title
Click here to learn what are the "Mandatory sender details"
Mandatory sender details are a list of values that have to be specified during the onboarding process or when creating a new MailUp list Here is the full list:
Field name
Type
Description
Name
String
List name (max 50 characters)
Business
Boolean
True if your mailing is directed to businesses
Customer
Boolean
True if your mailing is directed to consumers
OwnerEmail
String
"FROM" email: the email address that is sending the message. Make sure that it is a recognizable address (e.g. it uses your Web site domain). For security reason, please trust this email address, as explain by the method Trust an email address.
ReplyTo
String
If your newsletter asks for a reply from the recipients, you may want the replies to be sent to a different address from the "FROM" email. Enter the reply-to address here: it must be a valid email address. If you leave the field blank, the "FROM" address (see "owneremail" field) will be used. For security reason, please trust this email address, as explain by the method Trust an email address.
DisplayAs
String
This is the name that will be displayed in the "To" section of the e-mail message heading. Name can be customized with dynamic fields using "campoN" labels (e.g. campo1,campo2, etc.), where N is the progressive number of the dynamic field
NLSenderName
String
Email sender name: the person or entity that is sending the message. It could simply be your company name.
CompanyName
String
The name of the company that is responsible for the messages sent out form this list. This field and the others that follows should be included as "sender information" in each message sent. Please refer to this page for more details
ContactName
String
The contact reference name
Address
String
The company's address
City
String
The company's city
CountryCode
String
The company's country. Please use one of the Country codes provided by the method Get List of Country codes.
PermissionReminder
String
Use this field to remind recipients of why they are receiving messages. For example, you can use a message like this:
You are receiving this message because you registered on our Web site and agreed to receive email communication from us.
WebSiteUrl
String
The company's web site url
Now that you know what we need to create your new list, let's create it!
As you may have seen in the response of the previous sectionobject shown above, a MailUp list has many parameters that, during creation, you can inherit from a specified list or from the default settings. But sometimes Sometimes you could may have to create a list configuring not mandatory (like a description) or technical (like customize your brand new list by overriding some of the default values (e.g. the description, the maximum newsletter size...)parameters. To get more in-depth, the following table shows the optional fields:.
Expand
title
Request parameters - the full list
Field name
Type
Description
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
TimeZoneCode
String
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
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 http://consoleUrl/frontend/nl_catalog.aspx)
ScopeCode
Integer
select here which type of messages you are sending from this list:
0: Newsletters (default),
1: Direct_Advertising (promotions, direct marketing messages)
2: Transactional (transactional messages like alerts, reminders, notifications)
TrackOnOpened
Boolean
True when link tracking has to be enabled at list level
ConversionlabTrackCode
String
Code for tracking via conversionlab
LinkTrackingParameters
String
It allows the integration between the list and third-party services (CRM, analytics). Please, do not use question marks in this field. The platform appends this value to all tracking links sent via email. For Google Analytics use URL builder.
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"
Now you know all fields that could be used to create a list, but before creating your first advance list please remember that: