On this page:
...
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 | Go to automated doc | |||||||
JSON request (example) | none | |||||||
JSON response (example) |
| |||||||
Paging and filtering (example) |
...
| ||
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. 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 name | Type | Description |
---|---|---|
Name | String | List name (max 50 characters) |
Business | Boolean | True if your mailing is directed to businesses |
Customer | Boolean | True if your mailing is directed to consumers |
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). |
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. |
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 |
NLSenderName | String | Email sender name: the person or entity that is sending the message. It could simply be your company name. |
CompanyName | String | The 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 |
ContactName | String | The contact reference name |
Address | String | The company's address |
City | String | The company's city |
CountryCode | String | The company's country. Please use one of the Country codes provided by the method Get List of Country codes. |
PermissionReminder | String | Use 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. |
WebSiteUrl | String | The company's web site url |
Now that you know what we need to create your new list, let's create it!
Get started
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) |
| ||||||||
JSON response (example) |
| ||||||||
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 name | Type | Description |
---|---|---|
Description | String | Additional details about what the list is used for. |
Phone | String | The company's phone number |
PostalCode | String | The company's postal code |
StateOrProvince | String | The company's state or province |
TimeZoneCode | String | The list's time zone. Please use one of the TimeZoneCode codes provided by the method Get List of Time Zone codes. |
SmsSenderName | 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. |
DefaultPrefix | String | Default international prefix for mobile numbers (e.g. "0039" for Italy and "001" for United States) |
SendConfirmSms | Boolean | True when welcome SMS has to be sent for any new subscriber on SMS channel |
Charset | String | Text charset (see a list of Supported Charsets) |
Format | String | Format of emails to be sent with this list ("html" or "text") |
MultipartText | Boolean | Flag to automatically generate a text version of the message at sending stage |
KBMax | Integer | Message size beyond which a warning is generated. Suggested value = 100 |
NotifyEmail | String | Email address for unsubscribe notifications. Each time a recipient unsubscribes, an email will be sent to this address. |
OptoutType | 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) |
MultiOptoutList | 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 |
SendEmailOptout | Boolean | When true a "goodbye email" is sent to recipient that unsubscribe |
SubscribedEmail | Boolean | True when welcome email has to be sent for any new subscriber (it works only when double optin is implemented) |
BouncedEmail | String | Address for error messages |
FrontendForm | Boolean | Enable hosted subscription forms, which you can view and edit under Settings > List settings > List Building Tools. |
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) |
ScopeCode | Integer | select here which type of messages you are sending from this list:
|
TrackOnOpened | Boolean | True when link tracking has to be enabled at list level |
ConversionlabTrackCode | String | Code for tracking via conversionlab |
LinkTrackingParameters | String | It allows the integration between the list and third-party services (CRM, analytics). |
Old api method
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||
|
...
|
Update List
Description | Update an existing list | |||||||
---|---|---|---|---|---|---|---|---|
HTTP Method | PUT | |||||||
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/User/List/{List_ID} | |||||||
Reference | For details about parameters you can look at "Create List" method. | |||||||
JSON request (example) |
| |||||||
JSON response (example) |
| |||||||
Paging and filtering (example) |
|
Read Lists
Description | 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) | |||||||
---|---|---|---|---|---|---|---|---|
HTTP Method | GET | |||||||
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/User/Lists | |||||||
Reference | Go to automated doc | |||||||
JSON request (example) | none | |||||||
JSON response (example) |
| |||||||
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.
|
Add recipients to a list - subscribe
...
- 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
...