This page provides you information about how to manage recipients (subscribe, unsubscribe, update personal data).
On this page:
Confused with MailUp terminology? Please take a moment to review the Definitions and Recipients Management sections. |
A few definitions and important notes:
|
A single recipient can be added to a console account by calling the following methods:
You can choose to perform a double optin procedure for the given recipient by adding the querystring parameter "ConfirmEmail=true": in this case the recipient will be added to the given list/group in "Pending" status, and a confirmation email will be sent to that address, waiting for his/her confirmation. You can also update the information and status of an existing recipient by specifying his/her email address or mobile number as unique identifier of the existing recipient.
Based on the existing status, if available, and the ConfirmEmail parameter, the following scenarios hold true:
*Usually it does not matter if recipient is already subscribed/unsubscribed on another list, but be aware that a "key mismatch" may occur if recipient is already registered with a different phone number.In this casethe request is denied and no action applies |
Description | Retrieve recipient dynamic field definitions. | |||
---|---|---|---|---|
HTTP Method | POST | |||
URL | You can add a new recipient to a Console account, adding it to a specific List or a specific Group, by calling the following methods:
If you add a recipient to a group, automatically it will be added to the list related to that group.
To enable Confirmed Opt-In (COI) the querystring parameter ConfirmEmail must be set to true
| |||
JSON request (example) |
| |||
JSON response (example) | Recipient ID is returned (e.g. 77) | |||
Paging and filtering (example) | none |
This section refers to changes to a specific subscriber's personal data field (the subscriber must already exist)
The update operation requires:
Description | Retrieve recipient dynamic field definitions. | ||
---|---|---|---|
HTTP Method | PUT | ||
URL |
| ||
JSON request (example) |
| ||
JSON response (example) |
| ||
Paging and filtering (example) | none |
You can change the subscription status of an existing recipient in a specified List. To update multiple recipients at the same time, see Manage multiple recipients below.
Update operation requires
POST operation described in this section has been designed only to extend subscription to another list (e.g. recipient with ID=21 is already subscribed to list 1 and I want to add it also to list 2 -> POST /Console/List/2/Subscribe/21). |
Description | Add/remove the recipient with the related id in the List specified. | ||||
---|---|---|---|---|---|
HTTP Method | POST/DELETE | ||||
URL | Subscribe
Unsubscribe
| ||||
JSON request (example) | none | ||||
JSON response (example) | none | ||||
Paging and filtering (example) | none |
A group in MailUp is a subset of a list. Subscribe/unsubscribe is at the list level, not at the group level. Groups are typically used for segmentation purposes within a list.
You can use the API to assign or remove an existing recipient to/from a specified group. Removing a recipient from a group does not affect its list subscription status.
Update operation requires
Description | Add/remove the recipient with the related id to the specified group | |||||
---|---|---|---|---|---|---|
HTTP Method | POST/DELETE | |||||
URL | Add
Remove from a group
| |||||
JSON request (example) | none | |||||
JSON response (example) | none | |||||
Paging and filtering (example) | none |
This method allows you to:
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 do one of the following:
|
Description | Check subscriber and retreive data | |||
---|---|---|---|---|
HTTP Method | GET | |||
URL | see example in the "paging and filtering" row | |||
JSON request (example) | none | |||
JSON response (example) |
| |||
Paging and filtering (example) |
If you need to subscribe or unsubscribe multiple recipients it is strongly recommended to use an asynchronous method instead of calling many times the single import method. The Confimed Opt-in subscription method is availble in this mode by performing a few different API calls, as described below (see Send confirmation email).
Asynchronous import is used to perform a bulk import of several recipients into the specified list. Since the process is not synchronous, it is fast and it immediately returns an import ID (without waiting for the end of the import process), but it's not real time and there cannot be two or more imports at the same time with a single MailUp account. A HTTP 500 error with description="Resource internal error. Another import is running" is returned when you try to do more import at the same time. Please check the import status in order to know whether the import task has been completed.
In case of bulk import, the upper limit for parameter size is configured to support an upload size that is about 7MB for each call. This limit approximately corresponds to 5,000 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 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. |
The import process is able to recognize existing recipients (using the email address or the mobile number as unique identifiers), and update them according to the given input details. It is possible to add somequerystringparameters to specify some advanced behavior for the import process:
clearMissingOrEmptyFields: when set to "true", the import process clears on MailUp field that is not specified or set as empty in the request body.
removeFromPrevGroups: when set to "true", first the import process removes the given recipients from any group they have been part of, then it adds them only to the group specified along with this request. This querystring parameter applies only to "Import recipients into a group" cases.
ignoreMobile: (RECOMMENDED if you are not going to send SMS) when set to "true", the import process ignores the MobileNumber and MobilePrefix fields. As multi-channel import is much slower than single-channel import (up to 60 times), you should avoid importing on both channels when it is not mandatory for your business goals.
fileName: accepts a recipients' list in a file format instead of passing it through the request body. This option is recommended when uploading a large amount of data with a single call (e.g. more than 10K recipients). Please refer to the second of the links below for more details
*Confirmation request message will be sent immediately |
Prerequisite: you must have a valid MailUp FTP account. Please contact your sales representative or MailUp support to request one Here is how to import a list of recipients using the fileName parameter.
|
Description | Create and execute a task that imports specified recipients. Import task ID is returned | ||
---|---|---|---|
HTTP Method | POST | ||
URL | Import recipients into a list
Import recipients into a group (a group always belongs to a single list)
| ||
JSON request (example) |
| ||
JSON response (example) | 3 (import ID, a progressive number) | ||
Paging and filtering (example) | none |
The confirmation emails (generated in the bulk import process as the result of "ConfirmEmail=true"querystring parameter) can be sentwith the following process;
GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Import/{id_import}/Sending |
POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Email/Sendings/{id_sending}/Immediate POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Email/Sendings/{id_sending}/Deferred |
As stated above, bulk import tasks are asynchronous. Since you can run only one import task a time, it is important to check if there is a running process before starting a new one.
This section contains a method to query the status of a process by specifying its ID, a method to get a list of import tasks and a method to get all the details of a completed import.
Description | Read status of an import task by specifying its ID. List ID is not required. | |
---|---|---|
HTTP Method | GET | |
URL |
| |
JSON request (example) | none | |
JSON response (example) |
| |
Paging and filtering (example) | none |
Description | Retrieve the status codes of import tasks | ||
---|---|---|---|
HTTP Method | GET | ||
URL |
| ||
JSON request (example) | none | ||
JSON response (example) |
| ||
Paging and filtering (example) | None |
Description | Retrieve the list of all the import tasks | ||
---|---|---|---|
HTTP Method | GET | ||
URL |
| ||
JSON request (example) | none | ||
JSON response (example) |
| ||
Paging and filtering (example) |
|
Description | Retrieve the import details by specifying the import ID. This method is useful when the task is completed and you need a report of how many recipients have been imported | ||
---|---|---|---|
HTTP Method | GET | ||
URL |
| ||
JSON request (example) | none | ||
JSON response (example) |
| ||
Paging and filtering (example) | None |
Any update of recipients' personal data fields requires the IDs of the fields to be updated. Resource /Console/Recipient/DynamicFields allows you to retrieve personal data fields settings for a specific MailUp account (number of fields, names and IDs).
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 |
For each MailUp list and for each channel, these are the available subscription conditions:
"Unsubscribed" and "pending" conditions apply only to lists, not to groups.
Description | Retreive subscribed/unsubscribed recipients including all the available details about subscriptions and unsubscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
HTTP Method | GET | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL | For EMAIL channel:
For SMS channel:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JSON request (example) | none | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JSON response (example) |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Paging and filtering (examples) | 2 items per page, get first page (count starts from zero)
Retrieve the subscriber of a specified list whose Email is 'peter@example.com' filterby="Email=='peter@example.com'". Parameter names can be retreived from the response body. Please note that strict filter matching with "==" is much more performing than using "Contains" directive.
Retrieve all the subscribers of a specified list whose MobilePrefix is '0039' filterby="MobilePrefix=='0039'" and sort them by recipient identifier orderby="idRecipient asc". Parameter names can be retreived from the response body.
|
Description | Retreive subscribers of specified list | ||
---|---|---|---|
HTTP Method | GET | ||
URL | For EMAIL channel:
For SMS channel:
| ||
JSON request (example) | none | ||
JSON response (example) |
| ||
Paging and filtering (example) | 2 items per page, get first page (count starts from zero)
Filtering by channel:
NB: remember that parameter names can be retrieved from the response body. |
As for "subscribed", but in this case the endpoint is /Console/List/{ID_LIST}/Recipients/Unsubscribed.
For EMAIL channel:
GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{ID_LIST}/Recipients/Unsubscribed |
For SMS channel:
GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/List/{ID_LIST}/Recipients/Unsubscribed |
As for "subscribed", but in this case the endpoint is /Console/List/{ID_LIST}/Recipients/Pending.
For EMAIL channel:
GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{ID_LIST}/Recipients/Pending |
For SMS channel:
GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/List/{ID_LIST}/Recipients/Pending |
Description | Global search based on ID, email or mobile number | ||
---|---|---|---|
HTTP Method | GET | ||
URL |
| ||
JSON request (example) | none | ||
JSON response (example) |
| ||
Paging and filtering (example) |
A recipient can belong to zero, one or more groups of a list, regardless its subscription statusinthat list.
Description | Retrieve only email subscribers that belong to specified group. Group members that are not subscribed one mail 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 the subscriber of a specified list whose Email is 'peter@example.com' filterby="Email=='peter@example.com'". Parameter names can be retreived from the response body.
|
The same recipient can belong to different lists with a different subscription status. For example, imagine your account has three different lists: the same recipient belongs to the first list as subscribed, to the second one as unsubscribed and to the third one as pending.
The following method allows you to retrieve all the the list subscription statuses for the specified recipient.
Description | Retrieve the list subscription status by recipient | ||||
---|---|---|---|---|---|
HTTP Method | GET | ||||
URL | For EMAIL channel:
For SMS channel:
| ||||
JSON request (example) | none | ||||
JSON response (example) |
| ||||
Paging and filtering (example) | 2 items per page, get first page (count starts from zero)
Retrieve all the lists where the recipient is subscribed (OPTIN) filterBy="Status=='PENDING'" and sort them by Optin_Date descending orderBy="Optin_Date desc". Parameter names can be retreived from the response body.
|
This method could be very useful if you need to unsubscribe an optin recipient from multiple lists.
To perform this operation you need to specify into the body of the the array of list identifiers from which the recipient should be unsubscribed. As you can see in the box below, the response contains 2 arrays:
UnsubscribedFrom: this array contains the identifiers of the lists from which the method execution unsubscribes the recipient
NotUnsubscribedFrom: this array contains the identifiers of the lists from which the method execution does not unsubscribe the recipient, because:
Description | Unsubscribe a subscribed recipient from one or more specified lists | ||
---|---|---|---|
HTTP Method | DELETE | ||
URL | For EMAIL channel:
For SMS channel:
| ||
JSON request (example) |
| ||
JSON response (example) |
| ||
Paging and filtering (example) | - |
You can fully remove a recipient from a single list or from all lists. Personal data fields are kept (i.e. not deleted) until the recipient is present in at least one MailUp list, regardless its subscription status.
Description | Remove a recipient from a single list or from all lists | |||
---|---|---|---|---|
HTTP Method | DELETE | |||
URL |
Please note that the first endpoint uses "Recipient" (singular) while the second uses "Recipients" (plural) | |||
JSON request (example) | none | |||
JSON response (example) |
| |||
Paging and filtering (example) | - |
Email tracking (i.e. opens and clicks) can be enabled or disabled at recipient level.
Description | Enable or disable tracking | |||
---|---|---|---|---|
HTTP Method | POST | |||
URL |
| |||
JSON request (example) |
| |||
JSON response (example) |
The TimeStamp field is set only when disabling tracking. If you enable it, this field is cleared | |||
Paging and filtering (example) | - |
Before changing the tracking status, you may need to check the current value
Description | Read tracking status for a recipient on a specified list | |||
---|---|---|---|---|
HTTP Method | GET | |||
URL |
| |||
JSON request (example) | none | |||
JSON response (example) |
The TimeStamp field is set only when disabling tracking. If you enable it, this field is cleared | |||
Paging and filtering (example) | - |