Versions Compared

Key

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

 

 

BETA release
We are working to add new methods to this new API. If you don't find the methods that you are looking for please contact us
Info
Note
titlePhase out schedule

January 2019: Switch off version 1.1

September 2018: Switch off version 1.0

June 2018: All the methods related to any version of this service (v.1.0 and v.1.1) have been deprecated and no longer supported.



Overview

MailUpService is a new web service interface for accessing MailUp, Starting from year 2012,most of newly added methods to MailUp APIs will be included into this new interface. By means of most recent tecnologies, MailUp will be able to easily provide web services that family of special web service interfaces that have been developed to extend satisfy special needs. These interfaces that can be accessible with SOAP, REST (beta) or REST/JSONP

Availble sevices are designed to.

  • SOAP API is not deprecated and it continues to be supported, but future developments will be focused on this new API
  • MailUpService is version based: there will be a different endpoint for each major release of this web service. We recommend that you start using the version with highest number
  • In order to facilitate coexistence of calls to different MailUp APIs you can log in with an API and reuse the retrieved token with other MailUp APICreate/delete MailUp filters (MailUpService 1.0, using SOAP)
  • Use Javascript code to retrieve lists and messages without incurring in cross domain blocks (MailUpService 1.1, using JSONP)

 

If you are interested in using MailUpService you should be aware that

  • MailUpService is a set of extensions for MailUp SOAP API, it does not replace SOAP API (authentication features are shared between all these services)
  • Each extension is identified by a specific version (e.g. 1.0, 1.1) and a different endpoint
  • REST version is often restricted to HTTP POST usage, there are some exceptions with the methods that are available also for JSONP 
  • Naming convention is based on categories of methods. Method naming is like this: category+action+detail (see tables below). 

GroupCategoryDescription
Authenticationlogin and logout
FiltersManage MailUp filters
GroupsManage MailUp groups
RecipientsManage recipients (e.g. import, subscribe, get reports...)
EmailsManage email messages (e.g. create, retrieve and send email messages)
SMSManage text messages (e.g. create, retrieve and send SMS)

...