About MailUpImport | WS_MailUpImport Methods |
---|---|
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:
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:
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).
<mailupMessage> <mailupBody> <ReturnCode>0</ReturnCode> ... </mailupBody> </mailupMessage> |
Please note: if you receive a generic 500 error when attempting to use MailUpImport, the reason is typically authentication: Remember to authenticate yourself: this can be done either with an API call (see below) or manually in the admin console. |
Once the API account has been created, the MailUp APIs must be activated in order to be able to receive requests (they are disabled by default for safety reasons): they can be activated manually using the MailUp admin console or automatically by calling a specific URL. Deactivation is also done manually through the MailUp admin console. The IP address of the application using the web service must be registered (manually in the admin console or by performing the activation call).
To manually activate and configure the MailUp API in your MailUp admin console:
A third party application can enable web services via a call to:
http://<MAILUP_CONSOLE_URL>/frontend/WSActivation.aspx?usr=<usr>&pwd=<pwd>&nl_url=<nl_url>&ws_name=<ws_name>
MailUp provides an ASP.NET Web Form to allow third party applications to activate (if not already active) and register (store) the IP address of the caller. The form supports the parameters described below, both in GET and in POST modes:
MailUp will register the IP address of the computer calling, and therefore authorize future calls coming from that IP address. If the caller's IP address changes, WSActivation web service must be called again.
<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 > |
Code | Description |
---|---|
0 | request execution succeeded |
-2 | ws name has not been specified (1) |
-4 | user name has not been specified (1) |
-8 | password has not been specified (1) |
-16 | nl url has not been specified (1) |
-101 | mismatch between List ID and List GUID (where applicable) |
-1000 | unrecognized error |
-1001 | the account is not valid |
-1002 | the password is not valid |
-1003 | suspended account |
-1004 | inactive account |
-1005 | expired account |
-1006 | the web service is not enabled |
-1007 | the web service is not active |
-1008 | the web service is already active |
-1009 | web service activation error |
-1010 | IP registration error |
-1011 | IP is not registered |
-1012 | IP is registered but has the “deny access” flag |
-1013 | Missing authentication data |
-1014 | Login error: contract not signed |
(1) ReturnCode can be a combination of these
WS_MailUpImport checks the following parameters in order to authenticate requests:
Authentication fails if:
The WS_MailUpImport web service requires for every call an authentication via username and password; credentials must be passed in the header of the SOAP message.
Note that the API credentials are different from the credentials you use to log into your MailUp account. |
<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> |
Please Note: in the current release of the API the credentials passed in the authentication request are not encrypted. |
ReturnCode values in case authentication fails are shown below:
Error Code | Description |
---|---|
-1000 | unrecognized error |
-1001 | the account is not valid |
-1002 | the password is not valid |
-1003 | suspended account |
-1004 | inactive account |
-1005 | expired account |
-1006 | the web service is not enabled |
-1007 | the web service is not active |
-1011 | IP is not registered |
-1012 | IP is registered but has the "deny access" flag |
-1013 | Missing authentication data |
-1014 | Contract not signed |
All the methods requiring idList e listGuid at input execute a check on the input values and return one of the following:
Error Code | Description |
---|---|
-100 | unrecognized error |
-101 | verification failed |
-102 | list Guid format is not valid |
The WS_MailUpImport methods support up to 20 personal data fields. Should it be necessary to import more than 20 fields, there are other procedures that can be used. For example:
|