Manage single recipients (subscribe, unsubscribe, update)

Some possible scenarios are presented here - with the indication of the web services to be used - as examples of common scenarios. This is in no way an exhaustive overview of all the possible scenarios.

Please note that these cases do not talk about authentication and authorization, you should refer to the specific documentation of each technical solution for these details.

Case 1: email message and recipients exist in the MailUp admin console (click here to expand)

You may want to send a message to a group of users and both the message and the recipient's list are already available in the MailUp console.

REST API

If the message has to be sent to all the recipients in a list you can call POST /Console/List/{id_List}/Email/{id_Message}/Send.
If the message has to be sent to a group of a MailUp list you can call POST /Console/Group/{id_Group}/Email/{id_Message}/Send

The message, group, and list IDs can be found at the page Settings > Codes or they can be retrieved using API.

Case 2: not all recipients exist in the MailUp admin console (click here to expand)

Similar to Case 1, but in this case, a group of recipients has to be imported as well. Some of these recipients might be already subscribed to MailUp due to the previous signup to a newsletter, some others might be new subscribers. Here below some alternative solutions are listed, refer to Comparison Matrix to see how many recipients can be loaded with each solution.

REST API

REST API supports only sending to a single group or the whole list

To import recipients into a group of a MailUp list you may use POST /Console/Group/{ID_GROUP}/Recipients, while POST /Console/List/{id_List}/Recipients can be used to simply import into a MailUp list without specifying a group. Use POST /Console/List/{ID_LIST}/Group if you also need to create a new group.
1. the list of recipients can be provided in the request body or by specifying the name of a file you have previously uploaded via FTP. Refer to this page for more details
Use the methods listed in Case #1 for sending an email message with REST API

FTP

You can use FTP-ZIP to upload a zip archive containing the list of recipients, the message content, and a file descriptor with the mailing instructions. After the upload, MailUp does all the rest, preparing and scheduling the mailing process. Since the whole process is fully asynchronous, you can add an email address in the file descriptor to be notified when the process is completed

LIST+

List+ allows you to enclose a list of recipients to the message to be sent (by using a file named one2many.import) instead of sending to lists or groups that are already present in MailUp. Click here for more information about this feature

Case 3: creating and sending a message via the MailUp API (click here to expand)

In some cases, it may be necessary to import into MailUp a message created using an external system.

REST API

With the REST API, you can fully handle message tags, images, and attachments.

To create a message using POST /Console/List/{id_List}/Email, passing message content as a parameter. Check out this page to know more about the available options
Use the methods listed in Case #1 for sending an email message with REST API

LIST+

With List+ you can create an email message with your email client or your application and send it to a MailUp specific email address. Depending on the specified address, this action can lead to

save email message to MailUp and send it to all the recipients of a MailUp list
save email message to MailUp and send it to all the recipients of one or more groups in a MailUp list
save email message to MailUp without sending it
save email message to MailUp and send it to a recipient for test purposes

This solution is very powerful if you want to work outside the MailUp console account and it has some interesting additional features like the automatic upload of images, support for dynamic fields, and sender verification. In addition, List+ allows you to enclose a list of recipients (by using a file named one2many.import) instead of sending it to existing lists or groups.

Case 4: cloning a message to track separate mailings (click here to expand)

Most customers need to track campaign results. When the same message is sent more than once (e.g. three different times, to three different groups), the results are linked to the message ID, not to the individual mailings. If you need to have distinct results for each mailing, you can make a copy of the message before sending it again.

REST API

You can use GET /Console/List/{id_List}/Email/{id_Message} to get message content and then you need to create an identical message with POST /Console/List/{id_List}/Email

Case 5: massive sending of personalized messages via Web Services (click here to expand)

If you are in need to send a high number of personalized messages through the API, please refer to the section of "Transactional emails" or contact us.

REST API and List+

You can create personalized sections within your email using the Dynamic Content feature and MailUp filters. Dynamic Content is not available with email messages sent with HTTP GET/POST API and SMTP+

Action	Comments	Get/Post API
Confirm successful communication with the API	This method may be useful if your application needs to ping mailup to check current authentication and connection statuses.	WSActivation.aspx
Activation	You can enable HTTP GET/POST calls for any caller, you can restrict usage to a set of IPs or you can call a method that registers the caller IP to add it to the list of authorized IPs.	WSActivation.aspx
Single Subscribe (client-side)	Subscribes a single recipient to one or more lists (e.g. during checkout or registration) by calling a page that redirects to a landing page displaying the result	Subscribe.aspx
Single Subscribe (server side¹)	Subscribes a single recipient to one or more lists (e.g. during checkout or registration) and returns a result to the caller	Xmlsubscribe.aspx
Single Unsubscribe (server side¹)	Unsubscribes a single recipient from one or more lists (e.g. customer updates their account in the storefront) and returning a result	XmlUnsubscribe.aspx
Single Update (server side¹)	Updates a single recipient based on mapped data fields (e.g. first name, last name, etc) and return a result	XmlUpdSubscriber.aspx
Retrieve subscription status for a specific customer and list (server side¹)	Retrieves recipient’s status ( subscribed, pending, or unsubscribed )	XmlChkSubscriber.aspx

Action	Comments	REST API
Confirm successful communication with the API	Returns authentication information.	GET /Console/Authentication/Info
Retrieve Lists	Retrieves all lists related information	GET /Console/User/Lists
Retrieve Groups	Retrieves groups for a certain list	GET /Console/List/{ID_LIST}/Groups
Retrieve Fields	Retrieves the actual personal data field names along with ids. Useful for adding or updating subscribers’ personal information afterward.	GET /Console/Recipient/DynamicFields
Single Subscribe	Subscribes a single recipient to one list (e.g. during checkout or registration). A confirmed optin process can be implemented using the ConfirmEmail parameter	POST Console/List/{ListID}/Recipient (without COI) POST Console/List/{ListID}/Recipient?ConfirmEmail=true (with COI)
Single Unsubscribe	Unsubscribes a single recipient from one or more lists (e.g. customer updates their account in the storefront)	DELETE /Console/List/{id_List}/Subscribe/{id_Recipient}
Single Update	Updates a single recipient based on mapped data fields (e.g. first name, last name, etc)	PUT /Console/Recipient/Detail
Retrieve subscription status for a specific customer and list	Returns all subscribed recipients to a certain list	GET /Console/List/{id_List}/Recipients/Subscribed?filterby="Email.Contains('{Email}')"

Action	Comments	REST Web Services
Confirm successful communication with the API	Returns authentication information.	GET /Console/Authentication/Info
Retrieve Lists	Retrieves all lists related information	GET /Console/User/Lists
Retrieve Groups	Retrieves groups for a certain list	GET /Console/List/{ID_LIST}/Groups
Retrieve Fields	Retrieves the actual personal data field names along with ids. Useful for adding or updating subscribers’ personal information afterward.	GET /Console/Recipient/DynamicFields
Bulk Subscribe	Subscribes a set of recipients to a list	POST /Console/List/{id_List}/Recipients or POST /Console/Group/{ID_GROUP}/Recipients
Bulk Unsubscribe	Unsubscribes a set of recipients from a list	POST /Console/List/{id_List}/Recipients?importType='asOptout'
Bulk Update	Updates personal data fields of a set of recipients	POST /Console/List/{id_List}/Recipients or POST /Console/Group/{ID_GROUP}/Recipients
Retrieve the list of subscribers	Retrieves recipients that subscribed to a certain list	GET /Console/List/{ID_LIST}/Recipients/Subscribed

Num.	Action	Description	REST API	FTP
1	Create a new text message	Create a new text message with dynamic fields (optional) that can then be used as an "existing message" from the actions listed below (MESSAGE_ID is returned). A new message is also available on the MailUp console.	Createamessage
2	Single sending of EXISTING messages to a specified recipient	A single existing text message is sent to a single recipient by specifying MESSAGE_ID and destination number. A message shall be previously created and it can be customized using dynamic fields	SingleSend
3	TRANSACTIONAL single sending to a specified recipient	High personalization of messages, suitable for high volumes, effective data aggregation, no need to save content on MailUp console	Transactional SMS using APIs
4	Bulk sending of EXISTING messages to all subscribers or groups of them	A single existing text message is sent to many recipients (e.g. all list subscribers, one or more groups ...). by specifying MESSAGE_ID and List/group identifiers A message shall be previously created and it can be customized using dynamic fields	Sendtogroup/list
5	Bulk sending of NEW messages to all subscribers or groups of them	A new text message (with or without dynamic fields) has to be created and sent to a list of subscribers. Each action of this type creates a new message on the MailUp admin console. The greater is the number of messages and the higher is the load on the MailUp admin console, leading to lowering access time to web pages and response time of web services. Please use alternative solutions provided on this page if you have to make more than ten actions of this type per day	Createamessage + Sendtogroup/list
6	Bulk sending of NEW messages to a list of recipients with a specific text message for each recipient	In some cases, customization through dynamic fields could be not enough A list of {recipient + message text for this recipient} has to be provided as input and all messages shall be sent as a single campaign. This option has not had the side effects of option #5 and it also allows sending of completely different messages for each recipient.	N/A	SMS sending from CSV file
7	Immediate sending	For text messages to be sent as soon as possible	Createamessage + Sendtogroup/list	SMS sending from CSV file
8	Scheduled sending	For text messages to be sent at a specified time	Createamessage + Sendtogroup/list	SMS sending from CSV file
9	Sending of concatenated messages	When message length is higher than 160 characters (or higher than 70 chars if "Unicode" (use Unicode for non-western alphabets)	Createamessage + Sendtogroup/list	SMS sending from CSV file
10	Read Available credits	Retrieve the value of remaining credits (either as a whole at the account level or by list)	N/A
11	SMS Price	To know how many credits are used when sending an SMS in any country, visit SMS Credits & SMS Price

HTTP GET/POST and subscription forms

REST API

Webhooks

Synchronize recipients between your application and MailUp (i.e. bulk import and/or export)

FTP based integrations

REST API

Use confirmed opt-in (COI)

HTTP GET/POST and subscription forms

REST API

Manage suppression lists (i.e. "do not email" lists of recipients)

Send transactional and other personalized emails

SMTP or API: it's your choice

Message personalization

Bulk email messages

REST API

REST API

FTP

LIST+

REST API

LIST+

REST API

REST API and List+

Send Transactional or Bulk SMS

REST API, FTP

Extractor display statistics

REST API

FTP

Frontend

Browser not supported