WebService MailUpImport

Overview

The MailUpImport web service allows you to load into your MailUp account - using groups and lists - contacts coming from your database. It also allows you to retrieve details about lists, groups and the status of import operations, and also to segment the database. Among the tasks that you can perform using the MailUpImport Web Service:

• Get all the distribution Lists and the Groups contained in a given MailUp account;
• Create a new Group within an existing List;
• Upload a list of subscribers in order to create a new import process;
• Start the import process;
• Check on the import process status

Each method returns a XML string containing a "MailUp Message", which includes a "ReturnCode" and the requested information (when available). 
The ReturnCode is a number, with the following values:

• < 0 = error code
• 0 = call successful

MailUpImport WSDL location

The MailUpImport Web Services is described at the following URL:

http://<MAILUP_CONSOLE_URL>/Services/WSMailupImport.asmx?WSDL

... where <MAILUP_CONSOLE_URL> is the domain of your MailUp admin console. If you don't have that information, simply log into your MailUp admin console and look at the browser URL to locate the domain).

Sample ReturnCode

<mailupMessage>
<mailupBody>
<ReturnCode>0</ReturnCode>
...
</mailupBody>
</mailupMessage>

http://<MAILUP_CONSOLE_URL>/frontend/WSActivation.aspx?usr=<usr>&pwd=<pwd>&nl_url=<nl_url>&ws_name=<ws_name>

<mailupMessage>
<mailupBody>
<ReturnCode>0</ReturnCode>
<WS_Activation>
<WS_Name> WS_MailUpImport </WS_Name>
<DateOfRequest>2008-01-16</DateOfRequest>
<User>admin</User>
</WS_Activation>
</mailupBody>
</mailupMessage >

WS_MailUpImport checks the following parameters in order to authenticate requests:

• WS username
  • It is predefined for a specific MailUp account
  • It cannot be modified for that account
• WS password
  • It can be modified using the admin console (Manage > Web Services)
• IP address
  • MailUp check the IP address from which the request is coming and checks it against a list of IP addresses that have been provided

Authentication fails if:

• The MailUp API is disabled in your MailUp account (Manage > Web Services);
• username and/or password are incorrect;
• the IP address of the third party application has changed since the last successful access. The IP address can be manually changed in the MailUp admin console (Manage > Web Services).

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<Authentication xmlns="http://tempuri.org/">
<User>a21351</User>
<Password>URY256872UYT</Password>
</Authentication>
</soap:Header>
<soap:Body>
...
</soap:Body>
</soap:Envelope>

Note about Data Fields