Manage Lists and Groups
On this page:
- 1 Lists
- 1.1 Get List country codes
- 1.2 Get Time Zone codes
- 1.3 Create List
- 1.3.1 Quick list creation
- 1.3.2 Advanced list creation
- 1.3.3 Old "create list" method
- 1.4 Get list details
- 1.5 Update List
- 1.5.1 Old update list method
- 1.6 Delete List
- 1.7 Read Lists
- 1.7.1 Old read lists method
- 1.8 Add recipients to a list - subscribe
- 1.9 Remove recipients from a list - unsubscribe
- 1.10 Trust your list's email addresses
- 1.10.1 Trust an email address
- 1.10.2 Get trusted email addresses
- 1.10.3 Get a trusted email address details
- 1.10.4 Disable an email address
- 2 Groups
It is recommended that you do not create a new list for each campaign, to avoid performance issues we suggest you not exceed the limit of 100 lists for each console account.
Lists
Get List country codes
Description | Return the list of available country codes to create or update a list |
|---|---|
HTTP Method | GET |
URL | http://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/Countries |
Reference | |
JSON request (example) | none |
JSON response (example) | [
{
"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) |
|
Get Time Zone codes
Description | Return the list of Time Zone codes to create or update a list |
|---|---|
HTTP Method | GET |
URL | http://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/TimeZones |
Reference | |
JSON request (example) | none |
JSON response (example) | [
{
"OffsetFromUTC": "0:00:00",
"TimeZoneCode": "UTC+00:00.0",
"TimeZoneDescription": "(UTC) Casablanca",
"TimeZoneName": "Morocco Standard Time"
},
{
"OffsetFromUTC": "0:00:00",
"TimeZoneCode": "UTC+00:00.1",
"TimeZoneDescription": "(UTC) Coordinated Universal Time",
"TimeZoneName": "UTC"
},
{
"OffsetFromUTC": "0:00:00",
"TimeZoneCode": "UTC+00:00.2",
"TimeZoneDescription": "(UTC) Dublin, Edinburgh, Lisbon, London",
"TimeZoneName": "GMT Standard Time"
},
{
"OffsetFromUTC": "0:00:00",
"TimeZoneCode": "UTC+00:00.3",
"TimeZoneDescription": "(UTC) Monrovia, Reykjavik",
"TimeZoneName": "Greenwich Standard Time"
},
...
{
"OffsetFromUTC": "-11:00:00",
"TimeZoneCode": "UTC-11:00.0",
"TimeZoneDescription": "(UTC-11:00) Coordinated Universal Time-11",
"TimeZoneName": "UTC-11"
},
{
"OffsetFromUTC": "-12:00:00",
"TimeZoneCode": "UTC-12:00.0",
"TimeZoneDescription": "(UTC-12:00) International Date Line West",
"TimeZoneName": "Dateline Standard Time"
}
] |
Paging and filtering (example) |
|
Create List
Apr 12, 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
you always have to specify the so called "mandatory sender details" (see below)
at least one between "IdSetting" and "UseDefaultSettings" has to be included in the request data
you can also add any of the other optional fields (see the full list below)
Description | Create a new list |
|---|---|
HTTP Method | POST |
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List |
Reference | |
JSON request (example) |
{
"Name":"New Arrivals",
"Business":true,
"Customer":true,
"OwnerEmail":"jane@example.com",
"ReplyTo":"mike@example.com",
"NLSenderName": "Your sender name",
"CompanyName":"Your company",
"ContactName":"Your name",
"Address":"Your address",
"City":"Your city",
"CountryCode":"IT",
"PermissionReminder":"Your permission reminder",
"WebSiteUrl":"Your site",
"IdSettings":14
}
{
"Name":"New Arrivals",
"Business":true,
"Customer":true,
"OwnerEmail":"jane@example.com",
"ReplyTo":"mike@example.com",
"NLSenderName": "Your sender 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) | {
"IdList": 19,
"ListGuid": "57f9c675-63d6-498f-91b6-7f60f9f30b2e",
"Name": "New Arrivals",
"Description": "",
"NLSenderName": "Your sender 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": "",
"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 list creation
As you may have seen in the response object shown above, a MailUp list has many parameters that, during creation, you can inherit from a specified list or from the default settings. Sometimes you may have to customize your brand new list by overriding some of the default values (e.g. the description, the maximum newsletter size...).
Description | Create a new list |
|---|---|
HTTP Method | POST |
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List |
Reference | |
JSON request (example) |
{
"Name": "New Arrivals",
"Business": true,
"Customer": true,
"OwnerEmail": "jane@example.com",
"ReplyTo": "mike@example.com",
"DisplayAs": "",
"NLSenderName": "Your sender 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
}
{
"Name": "New Arrivals",
"Business": true,
"Customer": true,
"OwnerEmail": "jane@example.com",
"ReplyTo": "mike@example.com",
"DisplayAs": "",
"NLSenderName": "Your sender 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) | {
"IdList": 19,
"ListGuid": "57f9c675-63d6-498f-91b6-7f60f9f30b2e",
"Name": "New Arrivals",
"Description": "",
"NLSenderName": "Your sender 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": "",
"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) |
|
Old "create list" method
Get list details
Description | UGet list details by id |
|---|---|
HTTP Method | GET |
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List} |
Reference | |
JSON request (example) | none |
JSON response (example) | {
"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 Get the list details), change what you need, and then provide the object to the PUT method.
It's not necessary...
Updating a list, you can omit these fields:
IdSettings and UseDefaultSettings: they are necessary only to create a list
IdList and ListGuid: you cannot change these values, so do not provide them
Don't worry if you provide these values: the platform will ignore these values.
Description | Update an existing list |
|---|---|
HTTP Method | PUT |
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List} |
Reference | For details about parameters you can look at Create List method. |
JSON request (example) | {
"Name": "NEW LIST NAME",
"Description": "I ADDED THIS FEW LINES TO DESCRIBE THE PURPOUS OF THIS LIST",
"CompanyName": "Your MODIFIED company NAME",
"WebSiteUrl": "My NEW site",
"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": "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",
"ContactName": "Your name",
"CountryCode": "IT",
"Customer": true,
"DisplayAs": "Your sender name",
"NLSenderName": "Your list name",
"OwnerEmail": "jane@example.com",
"PermissionReminder": "Your permission reminder",
"Phone": "",
"PostalCode": "",
"ReplyTo": "mike@example.com",
"StateOrProvince": ""
} |
JSON response (example) | {
"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) |
|