Page tree

Versions Compared

Key

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

...

Expand
titleClick 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 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
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 listsender 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 listsender 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)
Expand
Code Block
languagejs
{
  "IdList": 19,
  "ListGuid": "57f9c675-63d6-498f-91b6-7f60f9f30b2e",
  "Name": "New Arrivals",
  "Description": "",
  "NLSenderName": "Your listsender 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) 

...

Expand
titleRequest parameters - the full list
Field nameTypeDescription
DescriptionStringAdditional details about what the list is used for.
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
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.

DisclaimerStringHeading added to the messages in the list
HeaderListUnsubscriberStringHeading "LIST-UNSUBSCRIBE" added to the messages in the list. Suggested value = "<[listunsubscribe]>,<[mailto_uns]>"
HeaderXAbuseStringHeading "X-ABUSE" added to the messages in the list. Suggested value = "Please report abuse here: http://[host]/p"

...

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 listsender 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 listsender 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
languagejs
{
  "IdList": 19,
  "ListGuid": "57f9c675-63d6-498f-91b6-7f60f9f30b2e",
  "Name": "New Arrivals",
  "Description": "",
  "NLSenderName": "Your listsender 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)  

...