Versions Compared

Key

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

Status
colourYellow
titleDEPRECATED

 

Table of Contents

 

Overview

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

...

provides new methods that allow cross domain requests (with HTTP GET)

...

Endpoints

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

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

Endpoints

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

 

Methods

...

Note

...

  • AuthenticationLogin
  • AuthenticationLogout

...

  • FiltersCreatePersonalDataFilter
  • FiltersDeletePersonalDataFilter
  • FiltersCreateActivityFilter
  • FiltersDeleteActivityFilter
  • FiltersCreateGeographicFilter
  • FiltersDeleteGeographicFilter

...

  • Ping

Authentication token is required, you can retreive it by means of LoginFromId (available in any of SOAP API web services) or using Authentication method provided by MailUpService 1.0

CategoryDescriptionAvailable methods
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

...

Configuration

...

 

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

 

Warning

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

JSONP methodJSONP-enabled methodsparametersnotes
ListsRead
  1. token
  2. idList
Returns available lists, similar to MailUpSend.GetLists.
Example:   https://services.mailup.com/1.1/MailUpService.svc/jsonp/ListsRead?token=tuhsWU7StetLw2tYp7CryKhFyzDQnSpBZJVHzFLmahSeaDmGAK8/zyOzsEhr&idList=1
EmailsRead
  1. token

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

 

Code Example

A detailed example is provided at this page: link