Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Accounts
How to get account info
Description | Returns profile info for authenticated user account |
---|---|
HTTP Method | GET |
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Authentication/Info |
Request JSON request parameters (example) | none |
JSON response (example) | {"Company":"nweb srl","IsTrial":true,"UID":"388","Username":"m1234","Version":"8.5"} |
Paging and filtering (example) | none |
How to create a console account
Lists and groups
How to get available lists
Note: methods for creating new lists through REST API are not yet available
Description | Return the lists that are visible for authenticated user | |||||
---|---|---|---|---|---|---|
HTTP Method | GET | |||||
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/User/Lists | |||||
Request parametersJSON 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.
|
How to manage groups
See here to learn more about the difference between lists and groups in MailUp
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 | |||||||||||||
JSON request (example) |
| nweb srl","IsTrial
| ||||||||||||
JSON response (example) |
| Paging and filtering (example) | none
| |||||||||||
Paging and filtering (example) | none |
Description | Modify 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} | |||||
JSON request (example) |
| |||||
JSON response (example) |
| |||||
Paging and filtering (example) | none |
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 | |||||
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.
|
Subscribers
Email messages
Statistics
Table of Contents | ||
---|---|---|
|