Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Version 1.1 of MailUp web services uses a different hostname than v. 1.0 and it has the following features:

  • Two new methods (marked with (plus) symbol) to retrieve available lists for a MailUp console and available email messages for a specified list
  • New methods support JSONP in order to allow cross domain requests (with HTTP GET) 
  • Full support of v. 1.0 methods

Endpoints

SOAP:   https://services.mailup.com/1.1/MailUpService.svc

REST:   https://services.mailup.com/1.1/MailUpService.svc/rest

JSONP:  https://services.mailup.com/1.1/MailUpService.svc/jsonp

 

Methods

GroupDescriptionAvailable methods
AuthenticationLogin and logout methods. 
Login returns an access key that can be used as parameter when calling other methods
  • AuthenticationLogin
  • AuthenticationLogout
FiltersCreate and delete MailUp filters.
  • FiltersCreatePersonalDataFilter
  • FiltersDeletePersonalDataFilter
  • FiltersCreateActivityFilter
  • FiltersDeleteActivityFilter
  • FiltersCreateGeographicFilter
  • FiltersDeleteGeographicFilter
TestThis group includes methods that can be used to test the service
  • Ping
EmailsThis group includes methods that manage email messages
  • EmailsRead (plus)
ListsThis group allows lists management
  • ListsRead (plus)

 

Using SOAP

As specified in WSDL, SOAP methods receives a specific "request" object as input parameter and return a specific "response" object. Please refer to the description of each method for more details.

Error Handling

In case of error a standard SOAP Fault object is returned (more on this)

Using REST

REST is supported only when XML parameters are passed with http POST method (Ping method is the only exception, which can be called using http GET https://services.mailup.com/1.1/MailUpService.svc/rest/Ping).
Required parameter format is the same as what is specified for SOAP requests (see example below).

Restrictions

  1. Available REST methods cannot be called using HTTP GET ("Ping" test method is the only exception, which can be called using http GET https://services.mailup.com/1.1/MailUpService.svc/rest/Ping)
  2. If you are experiencing some "cross domain problems" (i.e. you're unable to request data from a server in a different domain) you can try JSONP (available only for a subset of v.1.1 methods) 

Configuration

Please refer to REST configuration page to get some tips about enabling REST

 

Example

Please refer to examples provided for v. 1.0 (link).

 

Using JSONP

Each request is done using HTTP GET and the following format:

 https://services.mailup.com/1.1/MailUpService.svc/jsonp/MethodName?parameter1=value1&parameter2=value2

 

Due to security concerns, JSONP is available only for a subset of methods (see table below)

JSONP methodparametersnotes
ListsRead
  1. token
  2. idList
Returns available lists, similar to MailUpSend.GetLists
EmailsRead
  1. token

Returns available email messages for specified list, skipping cloned messages.
Provides the same reusult as MailUpSend.CloneMessages

 

Example

A detailed example is provided at this page: link

  • No labels