Tip | ||
---|---|---|
| ||
Click here to learn more about the difference between lists and groups in MailUp. |
...
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) |
| |||||||
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)
...
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) |
| |||||
JSON response (example) |
| |||||
Paging and filtering (example) | none |
...
Description | Updatea 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) |
| |||||
JSON response (example) |
| |||||
Paging and filtering (example) | none |
...
Description | Readgroups 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.
|
...
Description | Deletea 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 |
...
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"