Page Comparison

On this page:

...

Create List
Anchor
createlist
createlist

Note

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!

Now that you know what we need to create your new list, let's create it!

Tip
12 Apr 2017 NEW: we've added a new method for creating lists and deprecated the previous one. We recommend all of you using the old method to switch to the new one, which supports the new mandatory sender fields and returns a more complete data set.

Quick list creation

This is the minimum set of fields that are required to create a MailUp list using REST API. Please note that

...

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
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: Confirmed unsubscribe, 2: Confirmed unsubscribe with list preferences, 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:

...

title	Please remember that...

...

Description

Create a new list

HTTP Method

POST

URL

https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List

Reference

Go to automated doc

JSON request (example)

Inherit missing values from a specified list (i.e., list identifier equals to 14)

Expand

Code Block

{
  "Name": "New Arrivals",
  "Business": true,
  "Customer": true,
  "OwnerEmail": "jane@example.com",
  "ReplyTo": "mike@example.com",
  "DisplayAs": "Your sender name",
  "NLSenderName": "Your list name",
  "CompanyName": "Your company",
  "ContactName": "Your name",
  "Address": "Your address",
  "City": "Your city", 
  "CountryCode": "IT",
  "PermissionReminder": "Your permission reminder",
  "WebSiteUrl": "www.mailup.it",
  "Description": "",
  "Phone": "",
  "PostalCode": "",
  "StateOrProvince": "",
  "TimeZoneCode": "UTC+01:00.0",
  "SmsSenderName": "",
  "DefaultPrefix": "0039",
  "SendConfirmSms": false,
  "Charset": "UTF-8",
  "Format": "html",
  "MultipartText": true,
  "KBMax": 100,
  "NotifyEmail": "",
  "OptoutType": 3,
  "MultiOptoutList": "19",
  "SendEmailOptout": false,
  "SubscribedEmail": true,
  "BouncedEmail": null,
  "FrontendForm": true,
  "Public": true,
  "ScopeCode": 0,
  "TrackOnOpened": true
  "ConversionlabTrackCode": "",
  "LinkTrackingParameters": "",
  "Disclaimer": "Per l'informativa sulla privacy D.Lgs 196/2003 visitare l'home page del sito. <br/> Policy AntiSPAM garantita da <a href=\"http://www.mailup.it/email-marketing/policy-antispam.asp\" target=_blank><img src=\"http://doc.mailupnet.it/logo_small_R.gif\" border=\"0\" align=\"middle\" /></a>",
  "HeaderListUnsubscriber": "<[listunsubscribe]>,<[mailto_uns]>",
  "HeaderXAbuse": "Please report abuse here:  http://www.mailup.it/email-marketing/Policy-antispam_ENG.asp",
  "IdSettings": 14
}

Inherit missing values from default settings. they are the values used to create the first list (with identifier equals to 1)

Expand

Code Block

{
  "Name": "New Arrivals",
  "Business": true,
  "Customer": true,
  "OwnerEmail": "jane@example.com",
  "ReplyTo": "mike@example.com",
  "DisplayAs": "Your sender name",
  "NLSenderName": "Your list name",
  "CompanyName": "Your company",
  "ContactName": "Your name",
  "Address": "Your address",
  "City": "Your city", 
  "CountryCode": "IT",
  "PermissionReminder": "Your permission reminder",
  "WebSiteUrl": "www.mailup.it",
  "Description": "",
  "Phone": "",
  "PostalCode": "",
  "StateOrProvince": "",
  "TimeZoneCode": "UTC+01:00.0",
  "SmsSenderName": "",
  "DefaultPrefix": "0039",
  "SendConfirmSms": false,
  "Charset": "UTF-8",
  "Format": "html",
  "MultipartText": true,
  "KBMax": 100,
  "NotifyEmail": "",
  "OptoutType": 3,
  "MultiOptoutList": "19",
  "SendEmailOptout": false,
  "SubscribedEmail": true,
  "BouncedEmail": null,
  "FrontendForm": true,
  "Public": true,
  "ScopeCode": 0,
  "TrackOnOpened": true
  "ConversionlabTrackCode": "",
  "LinkTrackingParameters": "",
  "Disclaimer": "Per l'informativa sulla privacy D.Lgs 196/2003 visitare l'home page del sito. <br/> Policy AntiSPAM garantita da <a href=\"http://www.mailup.it/email-marketing/policy-antispam.asp\" target=_blank><img src=\"http://doc.mailupnet.it/logo_small_R.gif\" border=\"0\" align=\"middle\" /></a>",
  "HeaderListUnsubscriber": "<[listunsubscribe]>,<[mailto_uns]>",
  "HeaderXAbuse": "Please report abuse here:  http://www.mailup.it/email-marketing/Policy-antispam_ENG.asp",
  "UseDefaultSettings": true
}

JSON response (example)

Expand

Code Block

language	js

{
  "IdList": 19,
  "ListGuid": "57f9c675-63d6-498f-91b6-7f60f9f30b2e",
  "Name": "New Arrivals",
  "Description": "",
  "NLSenderName": "Your list name",
  "OwnerEmail": "jane@example.com",
  "PermissionReminder": "Your permission reminder",
  "Address": "Your address",
  "Business": true,
  "City": "Your city",
  "CompanyName": "Your company",
  "ContactName": "Your name",
  "CountryCode": "IT",
  "Customer": true,
  "DisplayAs": "Your sender name",
  "Phone": "",
  "PostalCode": "",
  "ReplyTo": "mike@example.com",
  "StateOrProvince": "",
  "WebSiteUrl": "www.mailup.it"
  "BouncedEmail": null,
  "Charset": "UTF-8",
  "ConversionlabTrackCode": "",
  "DefaultPrefix": "0039",
  "Disclaimer": "Per l'informativa sulla privacy D.Lgs 196/2003 visitare l'home page del sito. <br/> Policy AntiSPAM garantita da <a href=\"http://www.mailup.it/email-marketing/policy-antispam.asp\" target=_blank><img src=\"http://doc.mailupnet.it/logo_small_R.gif\" border=\"0\" align=\"middle\" /></a>",
  "Format": "html",
  "FrontendForm": true,
  "HeaderListUnsubscriber": "<[listunsubscribe]>,<[mailto_uns]>",
  "HeaderXAbuse": "Please report abuse here:  http://www.mailup.it/email-marketing/Policy-antispam_ENG.asp",
  "KBMax": 100,
  "LinkTrackingParameters": "",
  "MultiOptoutList": "19",
  "MultipartText": true,
  "NotifyEmail": "",
  "OptoutType": 3,
  "Public": true,
  "ScopeCode": 0,
  "SendConfirmSms": false,
  "SendEmailOptout": false,
  "SmsSenderName": "",
  "SubscribedEmail": true,
  "TimeZoneCode": "UTC+01:00.0",
  "TrackOnOpened": true
}

Paging and filtering (example)

...

add and subscribe one or more recipients. See "Import recipients".
force subscription of an existing recipient (i.e. unsubscribed or pending) by specifiying its ID. Refer to "Update subscription"

Remove recipients from a list - unsubscribe

...

Versions Compared

Old Version 56

New Version 57

Key

Create List
Anchor
createlist
createlist

Quick list creation

Remove recipients from a list - unsubscribe

Page Comparison

Versions Compared

Old Version 56

New Version 57

Key

Create List Anchorcreatelistcreatelist

Quick list creation

Remove recipients from a list - unsubscribe

Create List
Anchor
createlist
createlist