...
...
...
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
...
Table of Contents |
---|
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 |
JSON request parameters (example) |
---|
...
language | html/xml |
---|
none | |
JSON response (example) | {"Company":"nweb srl","IsTrial":true, |
---|
...
" |
...
UID":" |
...
388", |
...
" |
...
Username":" |
...
m1234", |
...
" |
...
Version": |
...
"8.5"} |
...
Paging and filtering (example)
none
Update
...
Description
...
Update a group starting from group ID
...
HTTP Method
...
Paging and filtering (example) |
---|
...
Code Block | ||
---|---|---|
| ||
{"Deletable":true,"Name":"Test REST API Group","Notes":"Notes should go here","idGroup":30,"idList":2} |
none |
How to create a console account
Refer to related document
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
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) |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
JSON response (example)
...
language | html/xml |
---|
...
URL
...
| |
Paging and filtering (example) |
---|
none
Read
...
Description
...
Read groups of specified list
...
HTTP Method
...
GET
5 items per page, get first page (count starts from zero) |
...
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
...
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 | 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) |
| |||||
JSON response (example) |
| |||||
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) |
| |||||
JSON response (example) |
| |||||
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) |
---|
...
|
...
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
Asynchronous import of recipients
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 | ||
---|---|---|
| ||
[{
"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
Read Import status
...
Description
...
Read status of an import task by specifying its ID
...
HTTP Method
...
GET
...
URL
| ||||
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
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
Retrieve all subscribed/unsubscribed from a list
Subscribed
Description | Read groups 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/Recipients/Unsubscribed
Asynchronous import of recipients
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) |
| |||||
JSON response (example) | 3
| |||||
Paging and filtering (example) | none |
Read Import status
Description | Read status of an import task by specifying its ID | |||||
---|---|---|---|---|---|---|
HTTP Method | GET | |||||
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Import/{IMPORT_ID} | |||||
JSON request (example) | none
| |||||
JSON response (example) |
| |||||
Paging and filtering (example) | none |
How to subscribe/unsubscribe a single email recipient (synchronous)
Create (subscribe)
Description | Add a new subscriber to the specified list | |||||
---|---|---|---|---|---|---|
HTTP Method | POST | |||||
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{ID_LIST}/Recipients | |||||
JSON request (example) |
| |||||
JSON response (example) |
| |||||
Paging and filtering (example) | none |
How to update fields of a single email recipient
First of all, you need to get the ID of dynamic fields, then you can update the personal data fields of a subscriber. Please note that the subscriber must already exist.
Retrieve recipient dynamic field definitions
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/ |
...
JSON request (example)
...
none
...
JSON response (example)
...
Code Block | ||
---|---|---|
| ||
{"Completed":true,"CreatedRecipients":1,"ImportedRecipients":0,"NotValidRecipients":0,"UpdatedRecipients":0,"ValidRecipients":1,"idImport":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) | none
|
How to subscribe/unsubscribe a single email recipient (synchronous)
...
JSON response (example) |
|
---|---|
Paging and filtering (example) |
|
Email messages
...
coming soon
Statistics
...
coming soon