| Status | ||||
|---|---|---|---|---|
|
| 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 |
|---|
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. |
...
- 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 |
| Category | Description | Available methods |
|---|---|---|
| Emails | This group includes methods that manage email messages |
|
| Lists | This group allows lists management |
|
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)
...
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
...
| 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).
Using JSONP
Each request is done using HTTP GET and the following format:
...
| JSONP-enabled methods | parameters | notes |
|---|---|---|
| ListsRead |
| Returns available lists, similar to MailUpSend.GetLists. Example: https://services.mailup.com/1.1/MailUpService.svc/jsonp/ListsRead?token=tuhsWU7StetLw2tYp7CryKhFyzDQnSpBZJVHzFLmahSeaDmGAK8/zyOzsEhr&idList=1 |
| EmailsRead |
| Returns available email messages for specified list, skipping cloned messages. |
Code Example
A detailed example is provided at this page: link