| Table of Contents |
|---|
Overview
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
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
...
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. |
| Category | Description | Available methods |
|---|---|---|
| Authentication | Login and logout methods. Login returns an access key that can be used as parameter when calling other methods |
|
| Filters | Create and delete MailUp filters. |
|
| Test | This group includes methods that can be used to test the service |
|
| 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)
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
- 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
- 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
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