Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this page:

...

Expand
titleDEPRECATED - Old method to create a new list
Note

MailUp copies data from the mandatory information fields of the list you are specifying as a reference, list 1 is used when 'useDefaultSettings=true'. This method fails returning a HTTP 500 error when the mandatory information fields to be copied are empty. 

DescriptionCreate a new list
HTTP MethodPOST
URLhttps://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/User/Lists
Reference

Go to automated doc

Expand
titleClick here to learn more about request parameters

Mandatory fields are marked in bold. To have an example of data formats you can have a look at the response of "Update List" method

Field nameTypeDescription

bouncedemail

StringAddress for error messages

charset

StringText charset (see a list of Supported Charsets)

conversionlab_trackcode

StringCode for tracking via conversionlab

default_prefix

StringDefault international prefix for mobile numbers (e.g. "0039" for Italy and "001" for United States)

description

StringAdditional details about what the list is used for.

disclaimer

StringHeading added to the messages in the list

displayas

StringThis 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

StringFormat of emails to be sent with this list ("html" or "text")

frontendform

BooleanEnable hosted subscription forms, which you can view and edit under Settings > List settings > List Building Tools.

headerlistunsubscriber

StringHeading "LIST-UNSUBSCRIBE" added to the messages in the list. Suggested value = "<[listunsubscribe]>,<[mailto_uns]>"

headerxabuse

StringHeading "X-ABUSE" added to the messages in the list. Suggested value = "Please report abuse here: http://[host]/p"

kbmax

IntegerMessage size beyond which a warning is generated. Suggested value = 100

multi_optout_list

StringDetail 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

BooleanFlag 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

StringEmail address for unsubscribe notifications. Each time a recipient unsubscribes, an email will be sent to this address.

optout_type

IntegerOptout 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 this email address, as explain by the method Trust an email address.

public

BooleanFlag 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

BooleanTrue when welcome SMS has to be sent for any new subscriber on SMS channel

sendemailoptout

BooleanWhen true a "goodbye email" is sent to recipient that unsubscribe

senderfax

StringDeprecated field, do not use it

senderfaxname

StringDeprecated field, do not use it

sms_sendername

StringDefault 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

BooleanTrue when welcome email has to be sent for any new subscriber (it works only when double optin is implemented)

tracking

BooleanTrue when link tracking has to be enabled at list level

Customer

BooleanTrue if your mailing is directed to consumers

Name

StringList name (max 50 characters)

business

BooleanTrue if your mailing is directed to businesses

copyTemplate

BooleanDeprecated field. Always use "false" value

copyWebhooks

BooleanWhen true and an existing list is set as template, then webhooks configuration is copied from that list

idSettings

IntegerID of an existing list to be used as template. This field is ignored when 'useDefaultSettings=true'

scope

Stringselect 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

BooleanWhen false, an existing list, specified by 'idSettings' field, is used as template. Otherwise default settings are used
CompanyNameStringThe 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
ContactNameStringThe contact reference name
AddressStringThe company's address
CityStringThe company's city
PostalCodeStringThe company's postal code
StateOrProvinceStringThe company's state or province
CountryCodeStringThe company's country. Please use one of the Country codes provided by the method Get List of Country codes.
PhoneStringThe company's phone number
WebSiteUrlStringThe company's web site url
PermissionReminderStringUse 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.
JSON request (example)
Expand
Code Block
{
   "Name":"New Arrivals",
   "useDefaultSettings":false,
   "idSettings":1,
   "business":true,
   "Customer":true,
   "scope":"newsletters",
   "owneremail":"jane@example.com",
   "format":"html",
   "copyTemplate":true,
   "copyWebhooks":true,
   "charset":"UTF-8",
   "public":true,
   "tracking":true,
   "optout_type":0,
   "sendemailoptout":false,
   "frontendform":true,
   "headerxabuse":"Please report abuse here: http://[host]/p",
   "kbmax":100,
   "replyto":"mike@example.com",
   "headerlistunsubscriber":"<[listunsubscribe]>,<[mailto_uns]>",
   "multipart_text":true,
   "subscribedemail":true,
   "sendconfirmsms":false,
   "CompanyName":"Your company",
   "ContactName":"Your name",
   "Address":"Your address",
   "City":"Your city",
   "PostalCode":"26100",
   "StateOrProvince":"Cremona",
   "CountryCode":"IT",
   "PermissionReminder":"Your permission reminder",
   "WebSiteUrl":"Your site",
   "Phone":"Your phone number",
}
JSON response (example)

List ID (e.g. 18)

 

Paging and filtering (example) 

Get list details by id

DescriptionUGet list details by id
HTTP MethodGET
URLhttps://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}
Reference

Go to automated doc 

JSON request (example)

none

JSON response (example)
Expand
Code Block
languagehtml/xml
{
  "BouncedEmail": null,
  "Charset": "UTF-8",
  "ConversionlabTrackCode": "",
  "DefaultPrefix": "0039",
  "Description": "I ADDED THIS FEW LINES TO DESCRIBE THE PURPOUS OF THIS LIST",
  "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": "21",
  "MultipartText": true,
  "NotifyEmail": null,
  "OptoutType": 3,
  "Public": true,
  "ScopeCode": 0,
  "SendConfirmSms": false,
  "SendEmailOptout": false,
  "SmsSenderName": "",
  "SubscribedEmail": true,
  "TimeZoneCode": "UTC+01:00.0",
  "TrackOnOpened": true,
  "Address": "Your address",
  "Business": true,
  "City": "Your city",
  "CompanyName": "Your MODIFIED company NAME",
  "ContactName": "Your name",
  "CountryCode": "IT",
  "Customer": true,
  "DisplayAs": "Your sender name",
  "IdList": 21,
  "ListGuid": "1239a201-47d1-46fa-b5a1-384ad6e78c60",
  "NLSenderName": "Your list name",
  "Name": "NEW LIST NAME",
  "OwnerEmail": "jane@example.com",
  "PermissionReminder": "Your permission reminder",
  "Phone": "",
  "PostalCode": "",
  "ReplyTo": "mike@example.com",
  "StateOrProvince": "",
  "WebSiteUrl": "My NEW site"
}
Paging and filtering (example) 

Update List

To update a list you have to provide an object that contains all the mandatory fields, even if you don't change them, and the optional fields that you want to modify. 
We suggest you to take the result of the method to create a list (or the method to retrieve the list by id), change what you need, and then provide the object to the PUT method.

...

  • 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

...