Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleClick here to expand and see available methods solutions for handling a single recipient
HTTP GET/POST and subscription forms

Subscription forms are based on HTTP GET/POST methods, which allow subscription unsubscription, check subscription status and update for a single recipient. These methods support optin, confirmed optin, optout, fields update, unsubscription. Refer to this page if you want to build a custom subscription form using AJAX. Retrieve fields feature is not available with HTTP GET/POST.

Expand
titleClick here to expand for more details...recommended methods

Action

Comments

Get/Post API

Confirm successful communication with the APIThis refers to confirming that the API credentials entered by the user are correct. The method used should return useful errors so that the user is informed of what might be going wrong.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 in order to add it to the list of authorized IPs.

WSActivation.aspx

Single Subscribe (client side)

Subscribing a single customer 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 side1)Subscribing a single customer to one or more lists (e.g. during checkout or registration) and returning a result to the callerXmlsubscribe.aspx

Single Unsubscribe (server side1)

Unsubscribing a single customer from one or more lists (e.g. customer updates their account in the storefront) and returning a result

XmlUnsubscribe.aspx

Single Update (server side1)

Updating a single customer based on mapped data fields (e.g. first name, last name, etc) and returning a result

XmlUpdSubscriber.aspx

Retrieve subscription status for a specific customer and list (server side1)

This refers to determining whether a certain customer is subscribed to a given list or not, so that the correct subscription preference can be shown in the ecommerce system your application (or to update locally stored subscription preferences).

XmlChkSubscriber.aspx

(1) requires server side development, this operation cannot be done directly from a client page because cross domain requests are blocked by the "same origin policy"


REST API

Rest API is the most complete solution for managing a single subscriber (subscription status, group membership and personal data fields) and it is the only MailUp solution that allows removal of a single recipient from a group. Adding a new recipient is an asynchronous process(i.e. method response does not mean that the operation is completed, you could use a specific method to get the status of requested operation). Retreive fields feature is available with GET /Console/Recipient/DynamicFields 

 

Expand
Webhooks

You can configure webhooks to enable a fast callback to your website when a recipient changes the subscription status or the personal data fields (e.g. by accessing to an autoprofile form). Callback method can be configured in order to include recipient's details as method parameter. Webhooks are managed by a worker process that is like a "frequent cron": you may experience some minutes of delay between the action and the corresponding callback. Bounces cannot be notified through webhooks.

SOAP API
You can extend StartImportProcess method of MailUpImport SOAP API, that is designed for bulk import, to work with a single recipient. This method supports optin, confirmed optin, forced optin, optout, fields update, unsubscription. Adding or updating a recipient with SOAP API is an asynchronous process (i.e. method response does not mean that the operation is completed, you could use a specific method to get the status of requested operation). Method MailUpSend.GetFields can be used to retreive field names.
titleClick here to expand for recommended methods

Action

Comments

REST API

Confirm successful communication with the API

This refers to confirming that the API credentials entered by the user are correct. The method used should return useful errors so that the user is informed of what might be going wrong.

GET /Console/Authentication/Info

Retrieve Lists

This refers to storing the information needed to then enable/disable Lists to be shown to users of the application so that they may subscribe/unsubscribe to/from different Lists

GET /Console/User/Lists

Retrieve GroupsThis refers to storing the information needed to pass a Group ID when sending data back to MailUp (e.g. to assign subscribers to a certain group)

GET /Console/List/{ID_LIST}/Groups

Retrieve Fields

This refers to storing field ID and field name to allow for mapping between fields in the MailUp account and those in the integrated application.

GET /Console/Recipient/DynamicFields

Single Subscribe

Subscribing a single customer to one or more lists (e.g. during checkout or registration)

POST /Console/List/{id_List}/Subscribe/{id_Recipient}

Single Unsubscribe

Unsubscribing a single customer from one or more lists (e.g. customer updates their account in the storefront)

DELETE /Console/List/{id_List}/Subscribe/{id_Recipient}

Single Update

Updating a single customer 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

This refers to determining whether a certain customer is subscribed to a given list or not, so that the correct subscription preference can be shown in your application (or to update locally stored subscription preferences).

GET /Console/List/{id_List}/Recipients/Subscribed?filterby="Email.Contains('{Email}')"


Webhooks

You can configure webhooks to enable a fast callback to your website when a recipient changes the subscription status or the personal data fields (e.g. by accessing to an autoprofile form). Callback method can be configured in order to include recipient's details as method parameter. Webhooks are managed by a worker process that is like a "frequent cron": you may experience some minutes of delay between the action and the corresponding callback. Bounces cannot be notified through webhooks.

SOAP API

You can extend StartImportProcess method of MailUpImport SOAP API, that is designed for bulk import, to work with a single recipient. This method supports optin, confirmed optin, forced optin, optout, fields update, unsubscription. Adding or updating a recipient with SOAP API is an asynchronous process (i.e. method response does not mean that the operation is completed, you could use a specific method to get the status of requested operation). Method MailUpSend.GetFields can be used to retreive field names.

Expand
titleClick here to expand for recommended methods

Action

Comments

SOAP Web Services

Confirm successful communication with the API

This refers to confirming that the API credentials entered by the user are correct. The method used should return useful errors so that the user is informed of what might be going wrong.

MailUpSend.LoginFromId

Retrieve Lists

This refers to storing the information needed to then enable/disable Lists to be shown to users of the application so that they may subscribe/unsubscribe to/from different Lists

MailUpImport.GetNlLists

Retrieve GroupsThis refers to storing the information needed to pass a Group ID when sending data back to MailUp (e.g. to assign subscribers to a certain group)

MailUpImport.GetNlLists or

WS_MailUpSend.GetGroups

Retrieve Fields

This refers to storing field ID and field name to allow for mapping between fields in the MailUp account and those in the integrated application.

MailUpSend.GetFields

Single Subscribe

Subscribing a single customer to one or more lists (e.g. during checkout or registration)

MailUpImport.StartImportProcesses

Single Unsubscribe

Unsubscribing a single customer from one or more lists (e.g. customer updates their account in the storefront)

MailUpImport.StartImportProcesses

Single Update

Updating a single customer based on mapped data fields (e.g. first name, last name, etc)

MailUpImport.StartImportProcesses

Retrieve subscription status for a specific customer and list

This refers to determining whether a certain customer is subscribed to a given list or not, so that the correct subscription preference can be shown in your application (or to update locally stored subscription preferences).

N/A


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

...

Expand
titleClick here to expand and see available methods
SOAP API, FTP

SOAP API offers a good and scalable solution for transactional SMS with SendDirectSMS, while other solutions are available for Bulk SMS, including "SMS sending from CSV file" feature that is provided for bulk sending personalized text messages using FTP. REST API does not support SMS yet.

The following table includes the recommended API methods to be used to perform certain tasks.

Num.ActionDescriptionSOAP APIOther methodsFTP
1Create new text messageCreate a new text message with dynamic fields (optional) that can then be used as "existing message" fro the actions listed below
(MESSAGE_ID is returned). New message is also available on MailUp console.
CreateSMS 
2Single 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.
Message shall be previously created and it can be customized by means of dynamic fields
SendSingleSMS 
3Single sending of NEW messages
to a specified recipient 
In this case existing messages cannot be used, a brand new text message (with or without dynamic fields) has to be created
and sent to a single recipient
SendDirectSMS 
4Bulk 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
Message shall be previously created and it can be customized by means of dynamic fields

SendSMS 
5Bulk 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.

Note

Each action of this type creates a new message on MailUp admin console.
The greater is the number of  messages and the higher is the load on MailUp admin console, leading to
slowering access time to web pages and response time of web services. Please use alternative solutions
provided in this page if you have to make more than ten actions of this type per day

CreateSMS  + SendSMS
or SendSmsFast

 
6Bulk 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 the side effects of option #5 and it also allows sending of completely different messages for each recipient.

N/ASMS sending from CSV file
7Immediate sendingFor text messages to be sent as soon as possibleSendSingleSMS 
SendDirectSMS  
SendSMS
SendSmsFast 
SMS sending from CSV file 
8Scheduled sendingFor text messages to be sent at specified timeSendSMS
SendSmsFast 
SMS sending from CSV file 
9Sending of concatenated messagesWhen message length is higher than 160 characters (or higher than 70 chars if "Unicode" (use Unicode for non western alphabets)SendSingleSMS 
SendDirectSMS  
SendSMS
SendSmsFast 
SMS sending from CSV file 

...