This page provides you information about how to manage recipients (subscribe, unsubscribe, update personal data).
MailUp for beginners
Do you still get stuck with MailUp terminology? Please refer to Definitions and Recipients Management sections
On this page:
Read personal data fields configuration
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
|
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 to a list
Description | 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.
|
Read unsubscribers
As for "subscribed", but in this case the endpoint is /Console/List/{ID_LIST}/Recipients/Unsubscribed. Note: this feature is applicable only to lists, not to groups
Read group members
Description | Retreive email subscribers that belong to specified group. Group members that are not subscribed on email channel are not returned |
|---|---|
HTTP Method | GET |
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Group/{id_Group}/Recipients
|
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.
|
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.
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 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) 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. List ID is not required. |
|---|---|
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) | {"Completed":true,"CreatedRecipients":1,"ImportedRecipients":0,"NotValidRecipients":0,"UpdatedRecipients":0,"ValidRecipients":1,"idImport":3}
|
Paging and filtering (example) | none
|
Manage a single email recipient
Create a new recipient and subscribe it to a list
A recipient can be added to a console account by calling Import Recipients and passing its details (at least one between email and mobile number and, optionally, personal data fields) as parameter.
| Use case | Action | Description |
|---|---|---|
| Brand new recipient | added and subscribed | not existing in any list of that account |
| Already subscribed on that list | personal data fields are updated | email address and mobile number are primary keys |
| Already subscribed/unsubscribed on another list | subscribed to specified list, personal data fields are updated | |
| Key mismatch | request is denied | Recipient was already present with both email address and mobile number, import operation provides the same email and a different mobile number (or viceversa) |
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) | [{
"Email":"test25@example.com",
"Fields":[{
"Description":"Region",
"Id":8,
"Value":"Italy"
}],
"Name":"Test"
}]
|
JSON response (example) | 8 |
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
Update operation requires
- 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 [{
"Email":"test25@example.com",
"Fields":[{
"Description":"Region",
"Id":8,
"Value":"England"
}],
"Name":"Test",
"idRecipient":23
}]
|
JSON response (example) | |
Paging and filtering (example) | none |
Email messages
coming soon
Statistics
coming soon