Default international prefix for mobile numbers (e.g. "0039" for Italy and "001" for United States)
description
String
Additional details about what the list is used for.
disclaimer
String
Heading added to the messages in the list
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
format
String
Format of emails to be sent with this list ("html" or "text")
frontendform
Boolean
Enable hosted subscription forms, which you can view and edit under Settings > List settings > List Building Tools.
headerlistunsubscriber
String
Heading "LIST-UNSUBSCRIBE" added to the messages in the list. Suggestedvalue = "<[listunsubscribe]>,<[mailto_uns]>"
headerxabuse
String
Heading "X-ABUSE" added to the messages in the list. Suggested value = "Please report abuse here: http://[host]/p"
kbmax
Integer
Message size beyond which a warning is generated. Suggested value = 100
multi_optout_list
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
multipart_text
Boolean
Flag to automatically generate a text version of the message at sending stage
nl_sendername
String
Email sender name: the person or entity that is sending the message. It could simply be your company name.
notifyemail
String
Email address for unsubscribe notifications. Each time a recipient unsubscribes, an email will be sent to this address.
optout_type
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)
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 your sender this email address, as explain hereby the method Trust an email address.
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)
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.
sendconfirmsms
Boolean
True when welcome SMS has to be sent for any new subscriber on SMS channel
sendemailoptout
Boolean
When true a "goodbye email" is sent to recipient that unsubscribe
senderfax
String
Deprecated field, do not use it
senderfaxname
String
Deprecated field, do not use it
sms_sendername
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.
subscribedemail
Boolean
True when welcome email has to be sent for any new subscriber (it works only when double optin is implemented)
tracking
Boolean
True when link tracking has to be enabled at list level
Customer
Boolean
True if your mailing is directed to consumers
Name
String
List name (max 50 characters)
business
Boolean
True if your mailing is directed to businesses
copyTemplate
Boolean
Deprecated field. Always use "false" value
copyWebhooks
Boolean
When true and an existing list is set as template, then webhooks configuration is copied from that list
idSettings
Integer
ID of an existing list to be used as template. This field is ignored when 'useDefaultSettings=true'
scope
String
select here which type of messages you are sending from this list: "newsletters" (default), "Direct_Advertising" (promotions, direct marketing messages), or "Transactional" (transactional messages like alerts, reminders, notifications)
useDefaultSettings
Boolean
When false, an existing list, specified by 'idSettings' field, is used as template. Otherwise default settings are used
For details about parameters you can look at "Create List" method. In addition, the Update method also requires the IdList field, which is the only mandatory field.
JSON request (example)
Code Block
{
"Name":"New Arrivals",
"description":"Use this list to inform subscribers about new products",
"IdList":2
}
Return the lists that are visible for authenticated user. If an existing list is not returned it is likely that the MailUp specified with the API is not enabled to see that list. Users with administrators grants can change this setting using the admin console account (i.e. the web application)
{"IsPaginated":false,
"Items":[{"Company":"","Description":"","Name":"Second List ","idList":2,"listGuid":"f34e5054-5555-4444-ffff-51acc36ae104"},
{"Company":"","Description":"This is a description","Name":"Newsletter ","idList":1,"listGuid":"49494949-4444-9999-8888-185543409eb7"}],
"PageNumber":0,"PageSize":5,"Skipped":0,"TotalElementsCount":2}
Paging and filtering (example)
5 items per page, get first page (count starts from zero)
Retreive all the lists whose name contains 'Newsletter'filterby="Name.Contains('Newsletter')" and sort them by ID orderby="idList desc". Parameter names can be retreived from the response body. Please note that "Contains" is case sensitive.