Versions Compared

Key

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

 

Table of Contents

...

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

 

Methods

Note

Due to technical reasons, methods that belong to Authentication, Filters and Test groups are temporary unavailable. Please refer to similar methods of v. 1.0 until availability of v.1.1 is fully restored. Expected restore date is 2012, July 10th.

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)

...

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)

...

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. Most of the available REST methods are to be called using HTTP POST, while. HTTP GET is available only for "Ping" (https://services.mailup.com/1.1/MailUpService.svc/rest/Ping) and JSONP-enabled methods
  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

...

 
Info

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

 

Example

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

...

JSONP-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