Page tree

Versions Compared

Key

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

...

DescriptionReturn the list of available country codes to create or update a list
HTTP MethodGET
URLhttp://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/Countries
ReferenceGo to automated doc
JSON request (example)none
JSON response (example)
Expand
Code Block
languagehtml/xml
[
  {
    "CountryCode": "AF",
    "CountryName": "Afghanistan"
  },
  {
    "CountryCode": "AL",
    "CountryName": "Albania"
  },
  {
    "CountryCode": "DZ",
    "CountryName": "Algeria"
  },
  {
    "CountryCode": "AR",
    "CountryName": "Argentina"
  },
  ...
  {
    "CountryCode": "VN",
    "CountryName": "Vietnam"
  },
  {
    "CountryCode": "YE",
    "CountryName": "Yemen"
  },
  {
    "CountryCode": "ZW",
    "CountryName": "Zimbabwe"
  }
]
Paging and filtering (example) 

 

Create List

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!

What are mandatory fields?

Mandatory fields are the required information you need to provide to create a new list. These information are the same you need to provide when you create a new list using your MailUp platform.
Here's the list of mandatory fields:

Field nameTypeDescription
NameStringList name (max 50 characters)
BusinessBooleanTrue if your mailing is directed to businesses
CustomerBooleanTrue if your mailing is directed to consumers
OwnerEmailString

"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.

ReplyToString

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

DisplayAsStringThis 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
NLSenderNameString

Email sender name: the person or entity that is sending the message. It could simply be your company name.

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
CountryCodeStringThe company's country. Please use one of the Country codes provided by the method Get List of Country codes.
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.
WebSiteUrlStringThe company's web site url

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

Get started

DescriptionCreate a new list
HTTP MethodPOST
URLhttps://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":"Your site",
   "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":"Your site",
   "UseDefaultSettings":true
}

 

 

JSON response (example)
Code Block
languagejs
{
  "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) 

Advanced

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.

Field nameTypeDescription
DescriptionStringAdditional details about what the list is used for.
PhoneStringThe company's phone number
PostalCodeStringThe company's postal code
StateOrProvinceStringThe company's state or province
TimeZoneCodeString

The list's time zone. Please use one of the TimeZoneCode codes provided by the method Get List of Time Zone codes.

SmsSenderNameStringDefault 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.
DefaultPrefixStringDefault international prefix for mobile numbers (e.g. "0039" for Italy and "001" for United States)
SendConfirmSmsBooleanTrue when welcome SMS has to be sent for any new subscriber on SMS channel
CharsetStringText charset (see a list of Supported Charsets)
FormatStringFormat of emails to be sent with this list ("html" or "text")
MultipartTextBooleanFlag to automatically generate a text version of the message at sending stage
KBMaxIntegerMessage size beyond which a warning is generated. Suggested value = 100
NotifyEmailStringEmail address for unsubscribe notifications. Each time a recipient unsubscribes, an email will be sent to this address.
OptoutTypeIntegerOptout settings that apply when a recipient unsubscribe (0: One-click unsubscribe, 1: , 2: 3: Confirmed unsubscribe with options, 4: Confirmed unsubscribe with Preference Center)
MultiOptoutListStringDetail 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
SendEmailOptoutBooleanWhen true a "goodbye email" is sent to recipient that unsubscribe
SubscribedEmailBooleanTrue when welcome email has to be sent for any new subscriber (it works only when double optin is implemented)
BouncedEmailStringAddress for error messages
FrontendFormBooleanEnable hosted subscription forms, which you can view and edit under Settings > List settings > List Building Tools.
PublicBooleanFlag 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)
ScopeCodeIntegerselect 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)
TrackOnOpenedBooleanTrue when link tracking has to be enabled at list level
ConversionlabTrackCodeStringCode for tracking via conversionlab
LinkTrackingParametersString

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.

Old api method

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) 

 

 

 

Update List

DescriptionUpdate an existing list
HTTP MethodPUT
URLhttps://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/User/List/{List_ID}
Reference

Go to automated doc 

 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
}
JSON response (example)
Expand
Code Block
languagehtml/xml
{
   "bouncedemail" : "g1g7g@g1g7g.bounce.smtpnext.com",
   "charset" : "UTF-8",
   "conversionlab_trackcode" : "",
   "default_prefix" : "001",
   "description" : "Use this list to inform subscribers about new products",
   "disclaimer" : "<br><br><font face=\"Verdana\" size=\"1\" color=\"#666666\">Privacy Protected with <a href=\"http://b1g7g.smtpnext.com/p\" target=_blank>Safely Subscribe System</a></font>",
   "displayas" : "campo1,campo2,campo3",
   "format" : "html",
   "frontendform" : true,
   "headerlistunsubscriber" : "<[listunsubscribe]>,<[mailto_uns]>",
   "headerxabuse" : "Please report abuse here: http://[host]/p",
   "kbmax" : 100,
   "multi_optout_list" : "2",
   "multipart_text" : true,
   "nl_sendername" : "John Smith",
   "notifyemail" : null,
   "optout_type" : 0,
   "owneremail" : "john@example.com",
   "public" : true,
   "replyto" : "mary@example.com",
   "sendconfirmsms" : false,
   "sendemailoptout" : false,
   "senderfax" : "",
   "senderfaxname" : "",
   "sms_sendername" : "SMSText",
   "subscribedemail" : true,
   "tracking" : true,
   "Customer" : true,
   "IdList" : 2,
   "Name" : "New Arrivals",
   "business" : true,
   "scope" : "newsletters",
   "CompanyName": "Your company name",
   "ContactName": "Your contact reference",
   "Address": "Your address",
   "City": "Your city",
   "CountryCode": "IT",
   "PermissionReminder": "Your permission reminder",
   "Phone": "Your phone number",
   "PostalCode": "26100",
   "StateOrProvince": "Cremona",
   "WebSiteUrl": "Your site"
}
Paging and filtering (example)

 

...