This page provides you information about how to manage recipients (subscribe, unsubscribe, update personal data).
...
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
...
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 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 |
| |||||||
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
...
Manage a single email recipient
Create a new
...
recipient
A single 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.
Code Block |
---|
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Recipients |
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) |
...
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 |
...