...
Accounts
How to get account info
Read
| Expand | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
How to create a console account
Feature is available, documentation is coming soon
Lists and groups
Click here to learn more about the difference between lists and groups in MailUp
How to get available lists
Note: methods for creating new lists through REST API are not yet available
Read
| Expand | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
How to manage groups
Create
...
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)
...
| Code Block | ||
|---|---|---|
| ||
{ "Deletable":true, "Name":"Test REST API Group", "Notes":"Notes should go here", "idList":2 } |
...
JSON response (example)
...
| Code Block | ||
|---|---|---|
| ||
{"Deletable":true,"Name":"Test REST API Group","Notes":"Notes should go here","idGroup":30,"idList":2} |
...
Paging and filtering (example)
none
Update
...
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}
...
JSON request (example)
...
| Code Block | ||
|---|---|---|
| ||
{ "Deletable":true, "Name":"Test REST API Group", "Notes":"I changed the notes again", "idGroup":30, "idList":2 } |
...
JSON response (example)
...
| Code Block | ||
|---|---|---|
| ||
{"Deletable":true,"Name":"Test REST API Group","Notes":"I changed the notes again","idGroup":30,"idList":2} |
...
Paging and filtering (example)
none
Read
...
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)
...
| Code Block | ||
|---|---|---|
| ||
{"IsPaginated":false,"Items":[{"Deletable":true,"Name":"Test REST API Group","Notes":"I changed the notes again","idGroup":30,"idList":2},{"Deletable":true,"Name":"buddies","Notes":"","idGroup":27,"idList":2},{"Deletable":false,"Name":"Autoprofile","Notes":"Subscribers that changed their profile","idGroup":26,"idList":2},{"Deletable":false,"Name":"Subscribed from social network","Notes":"Subscribed with their social network account.","idGroup":25,"idList":2},{"Deletable":false,"Name":"TEST","Notes":"Used for test sending.","idGroup":24,"idList":2}],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":5} |
...
Paging and filtering (example)
5 items per page, get first page (count starts from zero)
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/2/Groups?PageNumber=0&PageSize=5
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.
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/2/Groups?filterby="Name.Contains(%27Test%27)"&orderby="idGroup+asc"
Delete
...
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}
...
JSON request (example)
...
none
...
JSON response (example)
...
none
...
Paging and filtering (example)
none
Subscribers
You can subscribe a recipient to one or more lists or groups and you can also set personal data fields of the recipient.
Import and subscription are separate operations
How to subscribe/unsubscribe a single email recipient (synchronous)
Subscribe
Email messages
Statistics
...
| Tip | ||
|---|---|---|
| ||
We recommend to first take a peak at our Code Samples to familiarize with our API. |
API resources organized by topic
The following pages show you how to access the many resources made available by the MailUp REST API:
| Child pages (Children Display) | ||
|---|---|---|
|
...
In-depth technical details1
- More info about Authorization and resource access
- Automated documentation for accessing main resources
- Automated documentation for accessing statistics
(1) only for expert users
...
More about MailUp REST API