New to MailUp?
Click here to learn more about the difference between lists and groups in MailUp.
On this page:
It is recommended that you do not create a new list for each campaign, to avoid performance issues we suggest you to not exceed the limit of 100 lists for each console account.
Lists
Note: methods for deleting MailUp lists through REST API are not yet available
Create List
| Description | Create a new list |
|---|---|
| HTTP Method | POST |
| URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/User/Lists |
| Reference | |
| JSON request (example) | |
| JSON response (example) | List ID (e.g. 18)
|
| Paging and filtering (example) |
|
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. In addition, the Update method also requires the IdList field. |
| JSON request (example) | {
"Name":"New Arrivals",
"description":"Use this list to inform subscribers about new products",
"IdList":2
}
|
| 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)
You can use REST API to
- 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)
REST API include either a method for single (refer to "Update subscription") or bulk (asynchronous import with "asOptout" option) unsubscription.
Groups
Create Group
Description | Create a group into the specified list. Group ID is returned |
|---|---|
HTTP Method | POST |
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{ID_LIST}/Group |
| Reference | Go to automated doc |
JSON request (example) | { "Name":"Test REST API Group", "Notes":"Notes should go here" }
|
JSON response (example) | {"Deletable":true,"Name":"Test REST API Group","Notes":"Notes should go here","idGroup":30,"idList":2}
|
Paging and filtering (example) | none |
Update group
Description | Update a group starting from group ID |
|---|---|
HTTP Method | PUT |
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{ID_LIST}/Group/{ID_GROUP} |
| Reference | Go to automated doc |
JSON request (example) | { "Deletable":true, "Name":"Test REST API Group", "Notes":"I changed the notes again", "idGroup":30, "idList":2 }
|
JSON response (example) | {"Deletable":true,"Name":"Test REST API Group","Notes":"I changed the notes again","idGroup":30,"idList":2}
|
Paging and filtering (example) | none |
Read Groups
Description | Read groups of specified list |
|---|---|
HTTP Method | GET |
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{ID_LIST}/Groups |
| 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 groups whose name contains 'Test' filterby="Name.Contains('Test')" and sort them by ID orderby="idGroup asc". Parameter names can be retreived from the response body. Please note that "Contains" is case sensitive.
|
Delete Group
Description | Delete a group starting from group ID |
|---|---|
HTTP Method | DELETE |
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{ID_LIST}/Group/{ID_GROUP} |
| Reference | Go to automated doc |
JSON request (example) | none |
JSON response (example) | none |
Paging and filtering (example) | none |
Add recipients to a group
You can use REST API to
- add one or more recipients to a group and subscribe them to the MailUp list that contains the group. This double action is performed by a single operation, see "Import recipients" for details.
- add to a group an existing recipient by specifiying its ID. This operation also forces the subscription to the MailUp list of that group, refer to "Update group membership" for details.
Remove recipients from a group
REST API does not include yet a method for a bulk removal from a group, while the removal of a single recipient by specifying its ID is available. Refer to "Update group membership"