Page tree

Versions Compared

Key

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

...

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

MailUpSend.LoginFromId

Retrieve Lists

Retrieves all lists related information

MailUpImport.GetNlLists

Retrieve GroupsRetrieves groups

MailUpImport.GetNlLists or

WS_MailUpSend.GetGroups

Retrieve Fields

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

MailUpSend.GetFields

Bulk Subscribe

Subscribes a set of recipients to a list

MailUpImport.StartImportProcesses

Bulk Unsubscribe

Unsubscribes a set of recipients from a list

MailUpImport.StartImportProcesses

Bulk Update

Updates personal data fields of a set of recipients

MailUpImport.StartImportProcesses

Retrieve list of subscribers

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 you cannot pass more than 7MB input files can be uploaded with as a payload of a single import. For the export of recipients the paging feature is recommended to keep control on maximum size of transferred data. call. To overcome this limit, you may either split your list into multiple calls or provide a large file to be uploaded using FTP (the latter is the reccomended option in case of very large data set). The 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

Action

Comments

SOAP 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 GroupsRetrieves 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 afterwards.

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 list of subscribers

Retrieves recipients that subscribed to a certain list

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

...