This method creates and automatically starts an import process for the contacts listed in the xmlDoc parameter. You can use this method instead of calling a sequence of NewImportProcess and StartProcess methods. StartImportProcesses can also be used to update fields of an existing contact. Please note that, while updating, empty parameters are handled as "do not update this field", not as "overwrite with an empty value".
Method parameters
Mandatory fields must be specified even when they are empty. Optional fields can be skipped if you want to use the default value.
...
Note |
---|
An HTTP 500 Error is returned if optional parameters are included in the request with an empty value (Ex: <asOptOut /> or <asOptOut></asOptOut> ) |
Lists and Groups
You must specify at least one of the listIDs
or listsGUIDs
parameters. If you specify both fields, then the number of items in each parameter must match, and you must use semicolons to delineate empty values. We've provided examples below to help with understanding how to work with these parameters.
Add recipients to a single list (no groups)
In this example, we specify both the listsIDs
and the listsGUIDs
parameters. There are no groups, so we include an empty groupsIDs
tag.
Code Block |
---|
language | html/xml |
---|
linenumbers | true |
---|
|
<ws:listsIDs>1</ws:listsIDs>
<ws:listsGUIDs>66af9900-7dd7-4cca-9125-beadaf3a3a59;0e591119-xxxx-yyyy-zzzz-6ac75384b564</ws:listsGUIDs>
<ws:groupsIDs></ws:groupsIDs> |
Add recipients to a single list (single group)
In this example, we specify both the listsIDs
and the listsGUIDs
parameters, and since there is a single group we include it in the groupsIDs
parameter.
Code Block |
---|
language | html/xml |
---|
linenumbers | true |
---|
|
<ws:listsIDs>1</ws:listsIDs>
<ws:listsGUIDs>66af9900-7dd7-4cca-9125-beadaf3a3a59;0e591119-xxxx-yyyy-zzzz-6ac75384b564</ws:listsGUIDs>
<ws:groupsIDs>22</ws:groupsIDs> |
Add recipients to a single list (multiple groups)
In this example, we specify only the listsGUIDs
parameter. There are multiple groups for this list, so we separate them with a comma in the groupsIDs
parameter.
Code Block |
---|
language | html/xml |
---|
linenumbers | true |
---|
|
<ws:listsGUIDs>66af9900-7dd7-4cca-9125-beadaf3a3a59;0e591119-xxxx-yyyy-zzzz-6ac75384b564</ws:listsGUIDs>
<ws:groupsIDs>22,23</ws:groupsIDs> |
Add recipients to multiple lists (no groups)
In this example, we specify both the listsIDs
and the listsGUIDs
parameters. Each of the parameters must have the same number of elements (separated by semi-colons), so since there are no groups for either list, we include a single semi-colon in the groupsIDs
parameter to denote that there are two elements.
Code Block |
---|
language | html/xml |
---|
linenumbers | true |
---|
|
<ws:listsIDs>1;2</ws:listsIDs>
<ws:listsGUIDs>66af9900-7dd7-4cca-9125-beadaf3a3a59;0e591119-xxxx-yyyy-zzzz-6ac75384b564</ws:listsGUIDs>
<ws:groupsIDs>;</ws:groupsIDs> |
Add recipients to multiple lists (one group per list)
In this example, we specify both the listsIDs
and the listsGUIDs
parameters. Each of the parameters must have the same number of elements (separated by semi-colons). In this case, we are specifying group 22 for list 1, and group 13 for list 2.
Code Block |
---|
language | html/xml |
---|
linenumbers | true |
---|
|
<ws:listsIDs>1;2</ws:listsIDs>
<ws:listsGUIDs>66af9900-7dd7-4cca-9125-beadaf3a3a59;0e591119-xxxx-yyyy-zzzz-6ac75384b564</ws:listsGUIDs>
<ws:groupsIDs>22;13</ws:groupsIDs> |
Add recipients to multiple lists (multiple groups)
In this example, we specify both the listsIDs
and the listsGUIDs
parameters. The first list (ID=1) has two groups (22,23), so we use a comma to separate them in the first element. We then use a semi-colon to denote the second element, since the groupsIDs, listsIDs and listsGUIDs parameters must all have the same number of elements
Code Block |
---|
language | html/xml |
---|
linenumbers | true |
---|
|
<ws:listsIDs>1;2</ws:listsIDs>
<ws:listsGUIDs>66af9900-7dd7-4cca-9125-beadaf3a3a59;0e591119-xxxx-yyyy-zzzz-6ac75384b564</ws:listsGUIDs>
<ws:groupsIDs>22,23;13</ws:groupsIDs> |
XML Structure
The XML structure for each recipient needs to be consistent for all subscribers, and include empty tags for required values that are empty. When specifying the phone number for a recipient, the structure of your XML must match the mobileInputType
parameter, where either the entire phone number is represented in a single attribute, or the prefix and number are represented in separate attributes.
For example, if the mobileInputType
parameter is set to 1
,use the following XML structure:
Code Block |
---|
|
<!--Option 1: number and prefix in a single field (use mobileInputType=1)-->
<subscriber email="user@myprovider.com" Prefix="" Number="+0018889624587" Name=""> |
If the mobileInputType
parameter is set to 2
, use the following XML structure:
Code Block |
---|
|
<!--Option 2: number and prefix in separate fields (use mobileInputType=2)-->
<subscriber email="user@myprovider.com" Prefix="+001" Number="8889624587" Name=""> |
In case you also need to specify personal data fields an example is provided below
Note |
---|
Personal data fields shall be specified in progressive order and you shall also include empty fields. It is also recommended to use the same data structure for all subscribers. |
Code Block |
---|
language | html/xml |
---|
linenumbers | true |
---|
|
<subscribers>
<subscriber email="mike@example.com" Prefix="" Number="" Name="">
<campo1>Mike</campo1>
<campo2>Brown</campo2>
<campo3>Example Company</campo3>
<campo4>Los Angeles</campo4>
<campo5> </campo5>
<campo6>90125</campo6>
<campo7>CA</campo7>
<campo8>US</campo8>
<campo9>555 Some Street</campo9>
<campo10></campo10>
<campo11>555-123-1234</campo11>
</subscriber>
<!-- repeat for each recipient to import -->
</subscribers> |
You can use 0
and 1
in place of true
and false for boolean parameter values.
SOAP Examples
An example SOAP request to StartImportProcesses
:
...
Code Block |
---|
language | html/xml |
---|
linenumbers | true |
---|
|
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<StartImportProcessesResponse xmlns="http://ws.mailupnet.it/">
<StartImportProcessesResult><![CDATA[
<?xml version="1.0" encoding="windows-1252" ?>
<mailupMessage>
<mailupBody>
<ReturnCode>0</ReturnCode>
<processes>
<process>
<processID>69</processID>
<listID>1</listID>
<ReturnCode>0</ReturnCode>
</process>
<process>
<processID>70</processID>
<listID>2</listID>
<ReturnCode>0</ReturnCode>
</process>
</processes>
</mailupBody>
</mailupMessage>]]>
</StartImportProcessesResult>
</StartImportProcessesResponse>
</soap:Body>
</soap:Envelope> |
Error codes
Below is a list of the ReturnCode
values, and what they mean when an error is encountered.
Error code | Description |
---|
-200 | unrecognized error (it is likely that a mandatory parameter is missing) |
-400 | unrecognized error |
-401 | xmlDoc is empty |
-402 | convert xml to csv failed |
-403 | create new import process failed |
-410 | can not create confirmation email |
-450 | listsIDs and listsGUIDs must contain the same number of elements |
-600 | unrecognized error |
-601 | an import process is already running for the list |
-602 | an import process is already running for a different list |
-603 | error checking process status |
-604 | error starting the process job |
Code Examples
The code examples below are provided on an "as is" basis, without any warranty of any kind. MailUp shall not be held liable for any direct, indirect or consequential damages or costs of any type arising out of any action taken by you or other related to the example code. Please contact us if you are interested in submitting examples for programming languages that are not already included below.
Ruby
Code Block |
---|
language | ruby |
---|
linenumbers | true |
---|
|
# Refer to https://mailup.atlassian.net/wiki/display/mailupapi/MailUp+RubyGem for gem information.
require 'mail up'
m = MailUp::Import.new('username', 'password', 'console_url')
m.start_import_processes(
listsIDs: "1;2;3",
listsGUIDs: "abc123;def456;ghi789",
xmlDoc: xml_data_string,
groupsIDs: '',
importType: 3,
mobileInputType: 1
)
# => <?xml version=\"1.0\" encoding=\"windows-1252\" ?><mailupMessage><mailupBody><ReturnCode>0</ReturnCode><processes>...</processes></mailupBody></mailupMessage> |
PHP
Code Block |
---|
language | php |
---|
linenumbers | true |
---|
|
<?php
class MailUpWsImport {
protected $ns = "http://ws.mailupnet.it/";
//replace <console host name> with the host name of your console
protected $WSDLUrl = "http://<console host name>/services/WSMailUpImport.asmx?WSDL";
protected $headers = array("User" => "user", "Password" => "password");
protected $rCode;
private $soapClient;
private $xmlResponse;
protected $domResult;
function __construct() {
$this->header = new SOAPHeader($this->ns, "Authentication", $this->headers);
$this->soapClient = new SoapClient($this->WSDLUrl,array("trace" => 1,"exceptions" => 0));
$this->soapClient->__setSoapHeaders($this->header);
}
function __destruct() {
unset($this->soapClient);
}
//...
public function startImportProcesses($processData) {
try {
echo $processData."<br/><br/>";
$this->soapClient->StartImportProcesses($processData);
} catch (SoapFault $soapFault) {
var_dump($soapFault);
}
}
//...
}
$WsImport = new MailUpWsImport();
$xmlData = <<<EOT
<subscribers><subscriber email="test@example.com" Prefix="+39" Number="3351234567" Name="Test">
<campo1>Luigi</campo1><campo2>Rossi</campo2><campo3>Rossi consulting</campo3><campo4>Parma2</campo4><campo5>PR</campo5>
<campo6>43102</campo6><campo7></campo7><campo8>ITA</campo8><campo9>Via Garibaldi, 1</campo9><campo10>0521123456</campo10>
<campo11>0521123457</campo11></subscriber></subscribers>
EOT;
$startImportProcessData = array(
"listsIDs" => "4",
"listsGUIDs" => "3c5cb08c-f0b5-4bd6-9c2a-b687ecdac8b4",
"xmlDoc" => $xmlData,
"groupsIDs" => "22",
"importType" => "3",
"mobileInputType" => "2",
"asPending" => '0',
"ConfirmEmail" => "0",
"asOptOut" => "0",
"forceOptIn" => "0",
"replaceGroups" => "0"
);
$WsImport->startImportProcesses($startImportProcessData);
?> |
...