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)
...
language | html/xml |
---|
...
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 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) | 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 |
| |||||||
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 from a list
As for "subscribed", but in this case the endpoint is /Console/List/{ID_LIST}/Recipients/Unsubscribed
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 |
| |||||||
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
...
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 |
...