This page provides you information about how to manage recipients (subscribe, unsubscribe, update personal data).
...
Any update of recipients' personal data fields requires at least the IDs of the fields to be updated. Resource /Console/Recipient/DynamicFields DynamicFields allows you to retrieve personal data fields settings (numer number of fields, their names and the ID for each of them) of your console account. .
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 status 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 |
...
Note |
---|
In case of bulk import, the upper limit for parameter size is configured as 500MB to support an upload size that is about 7MB for each call. This limit approximately corresponds to 5000 recipients with 27 personal data fields (upload time = 300s) or 50,000 recipients with only email field (upload time = 370s). In any case, we recommend to set a configurable upload size limit in your application and make a test with this size. When parameter upload 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. |
...
- 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
|
...
You can use API to add or remove an existing recipient from a specified group. Removing a recipient from a group does not affect the list subscription status.
Update operation requires
- Recipient ID, refer to section "Check if a subscriber exists"
- The 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
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, |
...