Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: modificate le description delle tabelle

...

Expand
titleClick here to expand and see available solutions and recommended methods
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 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 wrongmethod 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 in order to add it to the list of authorized IPs.

WSActivation.aspx

Single Subscribe (client side)

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

Single Unsubscribe (server side1)

Unsubscribing 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 side1)

Updating Updates a single recipient 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 recipient 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).

XmlChkSubscriberRetrieves recipient’s status ( subscribed, pending or unsubscribed )

XmlChkSubscriber.aspx

(1) requires server side development, and in case of AJAX implementations, 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
titleClick here to expand for recommended methods
This 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)

Action

Comments

REST 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.

Returns authentication information.

 

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 Groups

Retrieves all lists related informaton

GET /Console/User/Lists

Retrieve Groups

Retrieves groups for a certain list

GET /Console/List/{ID_LIST}/Groups

Retrieve FieldsThis

refers to storing field ID and field name to allow for mapping between fields in the MailUp account and those in the integrated applicationRetrieves the actual personal data field names along with ids. Useful for adding or updating subscribers’ personal information afterwards.

GET /Console/Recipient/DynamicFields

Single Subscribe

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

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

Single Unsubscribe

Unsubscribing 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

Updating 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

This refers to determining whether a certain recipient 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).Returns all subscribed recipients to a certain list

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

Webhooks

You can configure webhooks to enable a fast callback to your website everytime a recipient changes the subscription status or any of the personal data fields (e.g. by filling in and submitting 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 the use of StartImportProcess method of MailUpImport SOAP API, that is designed for bulk import, to work with a single recipient. This method allows 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
Groups

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 wrongmethod has to be used to authenticate the admin console user against the web service.

MailUpSend.LoginFromId

Retrieve ListsThis 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

Retrieves all lists related informaton

 
Retrieve GroupsRetrieves groups

MailUpImport.GetNlLists or

WS_MailUpSend.GetGroups

Retrieve

This 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.

Fields

Retrieves the actual personal data field names along with ids. Useful for adding or updating subscribers’ personal information afterwards.

MailUpSend.GetFields

Single Subscribe

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

MailUpImport.StartImportProcesses

Single Unsubscribe

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

MailUpImport.StartImportProcesses

Single Update

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

MailUpImport.StartImportProcesses

Retrieve subscription status for a specific recipient/listThis refers to determining whether a certain recipient 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

N/A


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

...

Expand
titleClick here to expand and see available solutions and recommended methods
FTP based integrations

You can request your MailUp representative for a FTP Batch Process for massive data transfer using files CSV files. This feature can be used for very large amounts of recipients (this kind of process has been successfully tested with 4 millions of recipients in a single file).

Expand
titleClick here to know more about available FTP transfer types

You can request this feature to

Data transmission does not take place in real time: it is usually configured on a daily or weekly basis, but for specific cases even hourly schedule can be considered )

FTP based integrations can also be customized to import external campaign codes ( meant as customer’s application internal campaign or recipient identities )   without using personal data fields and to export email statistics with their reference to the external campaign code. This feature is not available with MailUp web services. More on this.

SOAP API

You can run MailUpImport SOAP API for an immediate import of recipients. In particular, you can use StartImportProcesses method, optionally combined with NewImportProcess if the amount of recipient is more than 5000. These methods also allow a batch import as "pending", and in this case, the confirmation email has to be manually sent using the admin console account. SOAP API is not bidirectional, so you cannot use it to export recipients from MailUp to your application.

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 Listsmethod has to be used to authenticate the admin console user against the web service.

MailUpSend.LoginFromId

Retrieve Lists

Retrieves all lists related informaton

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)Retrieves groups

MailUpImport.GetNlLists or

WS_MailUpSend.GetGroups

Retrieve FieldsThis

refers to storing field ID and field name to allow for mapping between fields in the MailUp account and those in the integrated applicationRetrieves the actual personal data field names along with ids. Useful for adding or updating subscribers’ personal information afterwards.

MailUpSend.GetFields

Bulk Subscribe

Subscribing Subscribes a set of recipients to a list

MailUpImport.StartImportProcesses

Bulk Unsubscribe

UnsubscribingUnsubscribes a set of recipients from a list

MailUpImport.StartImportProcesses

Bulk Update

Updating Updates personal data fields of a set of recipients

MailUpImport.StartImportProcesses

Retrieve list of subscribersRetrieving recipients that are subscribed to a list

N/A

N/A

SOAP API + FTP

You can get the best of FTP and SOAP API by using SendMessageNL API method, which performs scheduled sending of a message to a set of recipients that are included in the FTP import file previously processed (message ID and filename are passed as method parameter). In this case you have to transfer the file to MailUp before calling the method. Export of subscribed and unsubscribed recipients can be done with an FTP based integration.

REST API

Rest API allows immediate and bidirectional import and export of recipients. Due to restriction on HTTP channel, no more than 7MB input files can be uploaded with a single import. For the export of recipients the paging feature is recommended to keep control on maximum size of transferred data. REST API is the only MailUp solution that allows removal of a single recipient from a group.

Expand
titleClick here to expand for recommended methods
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 wrongThis 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)

Action

Comments

SOAP Web Services

Confirm successful communication with the API

Confirm successful communication with the API

Returns authentication information.

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 Groups

Retrieves all lists related informaton

GET /Console/User/Lists

Retrieve GroupsRetrieves groups for a certain list

GET /Console/List/{ID_LIST}/Groups

Retrieve FieldsThis

refers to storing field ID and field name to allow for mapping between fields in the MailUp account and those in the integrated applicationRetrieves the actual personal data field names along with ids. Useful for adding or updating subscribers’ personal information afterwards.

GET /Console/Recipient/DynamicFields

Bulk Subscribe

Subscribing Subscribes a set of recipients to a list

 POST /Console/List/{id_List}/Recipients or POST /Console/Group/{ID_GROUP}/Recipients

Bulk Unsubscribe

Unsubscribing Unsubscribes a set of recipients from a list

N/A

Bulk Update

Updating Updates personal data fields of a set of recipients

POST /Console/List/{id_List}/Recipients or POST /Console/Group/{ID_GROUP}/Recipients

Retrieve list of subscribers

Retrieving Retrieves recipients that are subscribed to a certain list

GET /Console/List/{ID_LIST}/Recipients/Subscribed

...