This page provides you information about how to manage recipients (subscribe, unsubscribe, update personal data).
...
- 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
|
...
- Recipient ID (refer to section "Check if a subscriber exists")
- List ID
Note |
---|
POST operation described in this section enables you to force subscription of unsubscribed recipients regardless the unsubscription reason. It is recommendend that you use this feature only if you're aware of its effects. |
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
|
...
- Recipient ID (see section "Check if a subscriber exists")
- Group ID
Description | Add/remove the recipient with the related id to the specified group | ||||
---|---|---|---|---|---|
HTTP Method | POST/DELETE | ||||
URL | Add
Remove
| ||||
JSON request (example) | none | ||||
JSON response (example) | none | ||||
Paging and filtering (example) | none |
Check if a subscriber exists
This method allows you to:
- verify whether a certain recipient is already a subscriber in a certain list within a specified MailUp account
- retrieve the recipientID and personal data fields for that recipient, if it is found
Note | ||
---|---|---|
| ||
At this time unfortunately the REST API does not include a method to search a recipient by email address regardless the subscription status, within a specific list. To accomplish that at the moment you will need to run the same search three times for subscribed, unsubscribed and finally pending recipients. |
...
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?PageNumber=0&PageSize=30&orderby="Id+asc" to get with a single response the full list ordered by Id, otherwise paging (20 items/page) is applied
|
...
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 statuses listed above at least in another list 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/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 |
...