This page provides you information about how to manage recipients (subscribe, unsubscribe, update personal data).
Tip | ||
---|---|---|
| ||
Do you still get stuck with MailUp terminology? Please refer to Definitions and Recipients Management sections |
On this page:
Table of Contents |
---|
Read personal data fields configuration
...
Description
...
Retrieve recipient dynamic field definitions.
...
HTTP Method
...
GET
...
URL
...
Code Block |
---|
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Recipient/DynamicFields |
...
JSON request (example)
...
none
...
JSON response (example)
...
Expand | |||||
---|---|---|---|---|---|
|
...
This page provides you information about how to manage recipients (subscribe, unsubscribe, update personal data).
Tip | ||
---|---|---|
| ||
Do you still get stuck with MailUp terminology? Please refer to Definitions and Recipients Management sections |
On this page:
Table of Contents |
---|
...
Read personal data fields configuration
Description | Retrieve recipient dynamic field definitions. | |||||||
---|---|---|---|---|---|---|---|---|
HTTP Method | 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/pending recipients from a list
For each MailUp list and for each channel, these are the available subscription conditions:
- subscribed
- unsubscribed
- pending
- not subscribed (has one of the status listed above at least in another list
...
You can subscribe a recipient to one or more lists or groups and you can also set personal data fields of the recipient.
...
- of that account)
"Unsubscribed" and "pending" conditions apply only to lists, not to groups.
Read subscribed recipients on Email channel
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.
|
Read unsubscribed recipients on Email channel
As for "subscribed", but in this case the endpoint is /Console/List/{ID_LIST}/Recipients/Unsubscribed.
Code Block |
---|
GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/ |
...
{ID_LIST}/Recipients/ |
...
Read unsubscribers
...
Unsubscribed |
Read pending recipients on Email channel
As for "subscribed", but in this case the endpoint is /Console/List/{ID_LIST}/Recipients/Pending.
Code Block |
---|
GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{ID_LIST}/Recipients/ |
...
Pending |
Retrieve recipients that belong to a group
A recipient can belong to zero, one or more groups of a list, regardless its subscription status in that list.
Read group members
Description | Retreive only email subscribers that belong to specified group. Group members that are not subscribed on email channel are not returned | |||||||
---|---|---|---|---|---|---|---|---|
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.
|
...
Asynchronous import of recipients
...
Code Block |
---|
POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/RecipientsRecipients |
You cannot create a new recipient without subscribing it
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
|
Update
...
personal data field of a subscriber
This section refers to changes on personal data fields of specified recipient (that must already exist)
...
- 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 |
| ||||
JSON request (example) |
| ||||
JSON response (example) |
| ||||
Paging and filtering (example) | none |
Update subscription status of a recipient
You can use API to force subscription or unsubscription status of an existing recipient on a specified list. Unsubscription though REST API can be performed only in this way, since bulk unsubscription is not available yet.
Update operation requires
- Recipient ID, refer to section "Check if a subscriber exists"
- List ID
Description | Add/remove the recipient with the related id to the specified group | ||||
---|---|---|---|---|---|
HTTP Method | POST/DELETE | ||||
URL | Subscribe
Unsubscribe
| ||||
JSON request (example) | none | ||||
JSON response (example) | none | ||||
Paging and filtering (example) | none |
Update group membership of a subscriber
You can use API to add or remove an existing recipient from a specified group.
Update operation requires
- Recipient ID, refer to section "Check if a subscriber exists"
- The Group ID
Description | Add a new subscriber /remove the recipient with the related id to the specified listgroup | ||||||
---|---|---|---|---|---|---|---|
HTTP Method | POST/DELETE | ||||||
URL | Add
| ||||||
JSON request (example) |
| ||||||
JSON response (example) |
| ||||||
Remove
| |||||||
JSON request (example) | none | ||||||
JSON response (example) | none | ||||||
Paging and filtering (example) | none |
Check if a subscriber exists
...
subscriber exists
With this method you can also retreive recipientID and personal data fields of the recipient with the specified email
Note | ||
---|---|---|
| ||
If you are using this method to retrieve recipient ID, unfotunately there is not a method that allows you to search recipient "by email address regardless the subscription status". Hence, it is possible that you have to make up to three search: in subscribed, in unsubscribed and finally in pending recipients of that list, |
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)" |
...
Email messages
coming soon
Statistics
coming soon