| Table of Contents |
|---|
...
| 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 | |||||
| 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.
|
How to manage groups
Create
...
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.
|
...
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 |
...
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
Retrieve all subscribed/unsubscribed from a list
Subscribed
Description | Read groups Retreive subscribers of specified list | |||||
|---|---|---|---|---|---|---|
HTTP Method | GET | |||||
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{ID_LIST}/Recipients/Subscribed | |||||
JSON request (example) | none | |||||
JSON response (example) |
| |||||
Paging and filtering (example) | 2 items per page, get first page (count starts from zero)
Retreive all the subscribers of a specified list whose Email contains 'example' filterby="Email.Contains('example')" and sort them by Email orderby="Email asc". Parameter names can be retreived from the response body. Please note that "Contains" is case sensitive.
|
Unsubscribed
As for "subscribed", but in this case the endpoint is /Console/List/1{ID_LIST}/Recipients/Unsubscribed
Asynchronous import of recipients
Asynchronous import is required when you have more than 10 recipients to be imported. It is fast but not immediate, please check the import status in order to know when the import task is completed.
When more import requests are pending, MailUp processes them in a sequential order.
Start import
Description | Create and execute a task that imports specified recipients. Import task ID is returned | |
|---|---|---|
HTTP Method | POST | |
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Group/{ID_GROUP}/Recipients | |
JSON request (example) |
Code Block | |
|
| Code Block | ||
|---|---|---|
| ||
[{
"Email":"john@doe.com",
"Name":"john doe",
"Fields":{
"FirstName":"john",
"LastName":"doe",
"Company":"john's Uber Awesome Company",
"Phone":"1115559999",
"LatestOrderId":1000,
"LatestOrderDate":"2013-12-13T16:52:08.3112622Z",
"LatestOrderAmount":100.99,
"LatestOrderProductIds":[100,101],
"LatestOrderCategoryIds":[1,2],
"LatestShippedOrderId":1000,
"LatestShippedOrderDate":"2013-12-14T16:52:08.3112622Z",
"TotalOrdered":100.99,
"TotalOrderedLastYear":825.99,
"TotalOrderedLastMonth":100.99,
"AllOrderedProductIds":[100,101]}
}] |
JSON response (example)
3
Paging and filtering (example)
none
...
Description | Retrieve recipient dynamic field definitions. | |||||
|---|---|---|---|---|---|---|
HTTP Method | GET | |||||
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Recipient/DynamicFields | |||||
JSON request (example) | none
| |||||
JSON response (example) |
| |||||
Paging and filtering (example) | Use endpoint /Console/Recipient/DynamicFields?&orderby="Id+asc" to get a list that is ordered by Id |
Check if a subscriber exists
With this method you can also retreive recipientID and personal data fields of specified subscriber
Description | Check subscriber and retreive data | |||||||
|---|---|---|---|---|---|---|---|---|
HTTP Method | GET | |||||||
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/3/Recipients/Subscribed?filterby="Email.Contains('{Email}')" see example in the "paging and filtering" row | |||||||
JSON request (example) | none
| |||||||
JSON response (example) | when the specified recipient belongs to list suscribers the response contains the personal data fields of the recipient
when the specified recipient does not belong to list subscribers (i.e. it may be not existing but also unsubscribed or subscribed only to other MailUp lists for that console account) an empty list is returned
| |||||||
Paging and filtering (example) | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/3/Recipients/Subscribed?filterby="Email.Contains(%27peter@example.com%27)" |
Change a personal data field of an existing subscriber
...
Description | Retrieve recipient dynamic field definitions. | |||
|---|---|---|---|---|
HTTP Method | PUT | |||
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Recipient/DynamicFields | |||
JSON request (example) | noneModifying the "Region" field
| |||
JSON response (example) |
| |||
Paging and filtering (example) | none |
Email messages
coming soon
...