This page provides you information about how to manage recipients (subscribe, unsubscribe, update personal data).
...
On this page:
| Table of Contents |
|---|
Retrieve all subscribed/unsubscribed from a list
...
Read personal data fields
...
configuration
Description | Retrieve recipient dynamic field definitions. |
|---|
...
HTTP Method | ||||||||
|---|---|---|---|---|---|---|---|---|
Description | Retreive subscribers of specified list | |||||||
HTTP Method | GET | |||||||
GET | ||||||||
URL |
| |||||||
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
|
...
Retrieve all subscribed/unsubscribed from a list
You can subscribe a recipient to one or more lists or groups and you can also set personal data fields of the recipient.
Subscribed
Description | Retreive subscribers of specified list | |||||||
|---|---|---|---|---|---|---|---|---|
HTTP Method | GET | |||||||
URL |
| |||||||
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/{ID_LIST}/Recipients/Unsubscribed
Asynchronous import of recipients
Asynchronous import is used either for adding a single recipient to MailUp or to perform a bulk import.
Since it's not synchronous, it is fast but not immediate, please check the import status in order to know when the import task is completed.
| Note |
|---|
In case of bulk import, the upper limit for parameter size is configured as 500MB for each call. In any case we recommend to set a configurable upload size limit in your application and make a test with this size. When parameter size exceeds this limit you can split the list of recipients in more blocks and perform more requests. When more import requests are pending, MailUp processes them in a sequential order. |
Import recipients
...
Description
...
Create and execute a task that imports specified recipients. Import task ID is returned
...
HTTP Method
...
POST
...
Import recipients into a list
| Code Block |
|---|
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Recipients |
Import recipients into a group (a group always belongs to a single list)
| Code Block |
|---|
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Group/{ID_GROUP}/Recipients |
...
JSON request (example)
...
| Expand | |||||
|---|---|---|---|---|---|
The example below imports two recipients. For each recipient to be imported you may specify a different set of "Fields" values. Please note that field value names are configurable and default values are language specific, therefore names in your console account can be different than what you see below
|
...
JSON response (example)
...
3
...
Paging and filtering (example)
none
Read Import Status
Description | Read status of an import task by specifying its ID. List ID is not required. | |||||
|---|---|---|---|---|---|---|
HTTP Method | GET | |||||
URL | ||||||
| Code Block |
| |||||
Paging and filtering (example) | 2 items per page, get first page (count starts from zero)
| Import/{IMPORT_ID}|||||
JSON request (example) | none
| |||||
JSON response (example) |
| |||||
Paging and filtering (example) | none
|
Manage a single email recipient
UpdateCreate a new recipient and subscribe it to a list
While subscribing a recipient you can also set personal data fields
Description | Add a new subscriber to the specified list |
|---|---|
HTTP Method | POST |
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/
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/{ID_LIST}/Recipients
...
JSON request (example)
...
| Code Block |
|---|
[{
"Email":"test25@example.com",
"Fields":[{
"Description":"Region",
"Id":8,
"Value":"Italy"
}],
"Name":"Test"
}] |
...
JSON response (example)
...
| Code Block | ||
|---|---|---|
| ||
8 |
...
Paging and filtering (example)
...
none
Read personal data fields configuration
...
Description
...
Retrieve recipient dynamic field definitions.
...
HTTP Method
...
GET
...
URL
/Unsubscribed
...
Asynchronous import of recipients
Asynchronous import is used either for adding a single recipient to MailUp or to perform a bulk import.
Since it's not synchronous, it is fast but not immediate, please check the import status in order to know when the import task is completed.
| Note |
|---|
In case of bulk import, the upper limit for parameter size is configured as 500MB for each call. In any case we recommend to set a configurable upload size limit in your application and make a test with this size. When parameter size exceeds this limit you can split the list of recipients in more blocks and perform more requests. When more import requests are pending, MailUp processes them in a sequential order. |
Import recipients
Description | Create and execute a task that imports specified recipients. Import task ID is returned | |||||||
|---|---|---|---|---|---|---|---|---|
HTTP Method | POST | |||||||
| URL | Import recipients into a list
| 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
Import recipients into a group (a group always belongs to a single list)
| |||||||
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. List ID is not required. | |||||
|---|---|---|---|---|---|---|
HTTP Method | GET | |||||
URL |
| |||||
JSON request (example) | none
| |||||
JSON response (example) |
| |||||
Paging and filtering (example) | none
|
...
Manage a single email recipient
UpdateCreate a new recipient and subscribe it to a list
While subscribing a recipient you can also set personal data fields
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
|
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) |
| |||||||||
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)" |
Update personal data of an existing subscriber
...
- Recipient ID, which can be retrieved with the operation listed above (Check if a subscriber exists)
- The IDs of the fields to be updated
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) | Modifying the "Region" field
| ||||
JSON response (example) |
| ||||
Paging and filtering (example) | none |
...