Recipients
This page provides you information about how to manage recipients (subscribe, unsubscribe, update personal data).
On this page:
New to MailUp?
Confused with MailUp terminology? Please take a moment to review the Definitions and Recipients Management sections.
A few definitions and important notes:
- Email Recipient: The person whose email address - and optionally other data - is added to MailUp.
- Email Recipient Status: A recipient's status may be subscribed, not subscribed, unsubscribed, or pending (i.e. pending subscription confirmation). A MailUp account can contain multiple Lists (e.g. "Monthly Newsletter", "Daily Specials", etc.). Status is List-specific.
- Email Subscriber: An email recipient whose status is "Subscribed"
- Subscription management is List-specific: Since Status is List-specific, the action to subscribe/unsubscribe is also list-specific. To subscribe/unsubscribe to/from multiple Lists you have to perform one subscribe/unsubscribe action for each target List.
- COI (Confirmed Optin, also known as double opt-in): A confirmed opt-in subscription process - a best practice in email marketing - is enforced only when explicitly requested via the ConfirmEmail parameter. When COI is enabled, a subscription request message is sent automatically. The content of that message can be found - and fully customized - in the list settings of your MailUp admin console.
- Remove VS unsubscribe: unsubscription is usually the preferred choice. It means you keep track that the recipient did an opt-out request. Removal means you want to fully delete a subscriber
Manage a single email recipient / subscriber
Add a single recipient / subscriber - synchronous import
A single recipient can be added to a console account by calling the following methods:
- POST /Console/List/{id_List}/Recipient
- POST /Console/Group/{id_Group}/Recipient
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.
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: POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Recipient
If you add a recipient to a group, automatically it will be added to the list related to that group. POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Group/{id_Group}/Recipient
To enable Confirmed Opt-In (COI) the querystring parameter ConfirmEmail must be set to true POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Recipient?ConfirmEmail=true
POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Group/{id_Group}/Recipient?ConfirmEmail=true
|
JSON request (example) | |
JSON response (example) | Recipient ID is returned (e.g. 77) |
Paging and filtering (example) | none |
Update personal data fields of a subscriber
This section refers to changes to a specific subscriber's personal data field (the subscriber must already exist)
The update operation requires:
- 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/Detail |
JSON request (example) | |
JSON response (example) | |
Paging and filtering (example) | none |
Update subscription status of a recipient
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
- Recipient ID (refer to section "Check if a subscriber exists")
- List ID
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).
The function here described cannot be used to force subscription of unsubscribed recipients: the only way to subscribe again an unsubscribed recipient is to import it with doubleoptin (i.e. imported as pending with confirmation request email e.g. POST /Console/List/2/Recipient?ConfirmEmail=true)
Description | Add/remove the recipient with the related id in the List specified. |
|---|---|
HTTP Method | POST/DELETE |
URL | Subscribe Email POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Subscribe/{id_Recipient}
SMS POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/List/{id_List}/Subscribe/{id_Recipient}
Unsubscribe Email DELETE https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Unsubscribe/{id_Recipient}
SMS DELETE https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/List/{id_List}/Unsubscribe/{id_Recipient}
|
JSON request (example) | none |
JSON response (example) | none |
Paging and filtering (example) | none |
Update group assignment
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
- 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 EMAIL - Also subscribes to the MailUp list the group belongs to (confirmSubscription=true by default) POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Group/{id_Group}/Subscribe/{id_Recipient}
SMS - Also subscribes to the MailUp list the group belongs to (confirmSubscription=true by default) POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/SMS/Group/{id_Group}/Subscribe/{id_Recipient}
EMAIL - Assigns to group without changing subscription status POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Group/{id_Group}/Subscribe/{id_Recipient}?confirmSubscription=false
SMS - Assigns to group without changing subscription status POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/SMS/Group/{id_Group}/Subscribe/{id_Recipient}?confirmSubscription=false
Remove from a group DELETE https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Group/{id_Group}/Unsubscribe/{id_Recipient}
|
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
Known restriction
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:
- run the same search three times for subscribed, unsubscribed and finally pending recipients.
- access to EmailOptins resource filtering by Status (requires the Recipient ID instead of the email address)
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) |
Manage multiple recipients
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).
Subscribe/unsubscribe recipients - asynchronous import
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:
- ConfirmEmail=true: if specified, sets the new recipients status to "Pending", and a confirmation email is generated (but not yet sent). Please check below in the section "Send Confirmation Email" the procedure to actually send the emails generated so far.
- importType=asOptout: if specified, the given recipients' status is set to "Optout", except for the ones already in “Pending” Status. A complete explanation of the available scenarios is provided below.
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
Description | Create and execute a task that imports specified recipients. Import task ID is returned |
|---|---|
HTTP Method | POST |
| URL | Import recipients into a list https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Recipients
Import recipients into a group (a group always belongs to a single list) https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Group/{ID_GROUP}/Recipients
|
JSON request (example) | |
JSON response (example) | 3 (import ID, a progressive number) |
Paging and filtering (example) | none |
Send Confirmation Email
The confirmation emails (generated in the bulk import process as the result of "ConfirmEmail=true"querystring parameter) can be sentwith the following process;
- Retrieve the SendingID of that confirmation email, with the following call, where {id_import} is the result of the current import call. The result of this GET call is a structure with the SendingID (idImport) and the number of generated emails (EnqueuedEmails).
GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Import/{id_import}/Sending
- Send the email immediately or planning a schedule by calling one of these methods where {id_sending} is the SendingID retrieved at previousstep, with no body. Moreover a body like {Date:'yyyy-MM-dd HH:mm'} is required: for the "Deferred" case. NOTE: the specified date must be in UTC and at least 5 minutes in the future, with the format described in the section 'Type and cast definition' of "Paging and filtering" page
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
Read import information
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.
Read Import Status
Description | Read status of an import task by specifying its ID. List ID is not required. |
|---|---|
HTTP Method | GET |
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Import/{IMPORT_ID}
|
JSON request (example) | none |
JSON response (example) | {"Completed":true,"CreatedRecipients":1,"ImportedRecipients":0,"NotValidRecipients":0,"UpdatedRecipients":0,"ValidRecipients":1,"idImport":3}
|
Paging and filtering (example) | none |
Get import status codes
Description | Retrieve the status codes of import tasks |
|---|---|
HTTP Method | GET |
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Imports/StatusCodes |
JSON request (example) | none |
JSON response (example) | |
Paging and filtering (example) | None |
Get list of import tasks
Description | Retrieve the list of all the import tasks |
|---|---|
HTTP Method | GET |
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Imports |
JSON request (example) | none |
JSON response (example) | |
Paging and filtering (example) |
|
Get import report
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 | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Imports/{id_Import}
|
JSON request (example) | none |
JSON response (example) | |
Paging and filtering (example) | None |
Read personal data fields configuration
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 | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Recipient/DynamicFields |
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 recipients with all subscription details
Description | Retreive subscribed/unsubscribed recipients including all the available details about subscriptions and unsubscription |
|---|---|
HTTP Method | GET |
URL | For EMAIL channel: All recipients that belong to a list https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{ID_LIST}/Recipients/EmailOptins
Only recipients that belong to at least one of the specified groups https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{ID_LIST}/Recipients/EmailOptins?Groups=GroupId1,GroupId2
For SMS channel: All recipients that belong to a list https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/List/{ID_LIST}/Recipients/SmsOptins
Only recipients that belong to at least one of the specified groups https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/List/{ID_LIST}/Recipients/SmsOptins?Groups=GroupId1,GroupId2
|
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.
|
Read subscribed recipients
Description | Retreive subscribers of specified list | ||
|---|---|---|---|
HTTP Method | GET | ||
| URL | For EMAIL channel: https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{ID_LIST}/Recipients/Subscribed
For SMS channel: https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/List/{ID_LIST}/Recipients/Subscribed
| ||
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. |
Read unsubscribed recipients
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
Read pending recipients
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
Retrieve recipients by ID, email or mobile number
Description | Global search based on ID, email or mobile number |
|---|---|
HTTP Method | GET |
URL | // Available options
// 1. get by ID
Console/Recipients/{id_Recipient}
// 2. get by email (max 10 email addresses)
Console/Recipients?email="email1,email2, ..., email10"
// 3. get by mobile number (max 10 numbers)
Console/Recipients?sms="prefixandnumber1,prefixandnumber2, ..., prefixandnumber10"
// 4. get recipients who matches at least one of the provided emails and mobile numbers
Console/Recipients?email="email1,email2"&sms="prefixandnumber1,prefixandnumber2"
|
JSON request (example) | none |
JSON response (example) | |
Paging and filtering (example) |
Retrieve recipients that belong to a group
A recipient can belong to zero, one or more groups of a list, regardless its subscription statusinthat list.
Read group members
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 | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Group/{id_Group}/Recipients
|
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.
|
Manage recipient subscription status
Retrieve recipient subscription status by list
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: https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Recipients/{id_Recipient}/EmailOptins
For SMS channel: https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Recipients/{id_Recipient}/SmsOptins
|
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.
|
Unsubscribe recipient from specified lists
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:
- it has already unsubscribed
- it was in a PENDING status
- the recipient does not belong to this list
Description | Unsubscribe a subscribed recipient from one or more specified lists |
|---|---|
HTTP Method | DELETE |
URL | For EMAIL channel: https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/Unsubscribe/{id_Recipient}
For SMS channel: https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/List/Unsubscribe/{id_Recipient}
|
JSON request (example) | [1,10] |
JSON response (example) | |
Paging and filtering (example) | - |
Remove recipient
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 | Remove from a list https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Recipient/{id_Recipient}
Remove from all lists https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Recipients/{id_Recipient}
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) | - |
Enable or disable tracking
Email tracking (i.e. opens and clicks) can be enabled or disabled at recipient level.
Description | Enable or disable tracking |
|---|---|
HTTP Method | POST |
URL | For a single list https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{{ID_LIST}}/Tracking/{{ID_RECIPIENT}}
For all the lists https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Tracking/{id_Recipient}
|
JSON request (example) | Disable tracking. According to the specified resource (endpoint) it applies to a single list or to all the lists {
"Enable": false
}
|
JSON response (example) | The TimeStamp field is set only when disabling tracking. If you enable it, this field is cleared |
Paging and filtering (example) | - |
Read tracking status
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 | For a single list https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Tracking/{id_Recipient}
|
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) | - |