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.
...
Parameter | |||
---|---|---|---|
listsIDs | Mandatory - List identifiers. You can include multiple list IDs, separated by semicolons. Example: | ||
listsGUIDs string | Mandatory - List GUIDs. You can include multiple list GUIDs, separated by semicolons. Example: | ||
xmlDoc | When specified: An XML string containing the recipients to be imported to the specified lists and groups. In this case the method Does not import any pending lists that were previously submitted using NewImportProccess If not specified (NULL): method sequentially imports all pending XML structures that have been previously submitted using NewImportProccess. This option is available only starting from MailUp 8.2.1 or higher See "Best Practices" and "XML Structure" sections below for known restrictions, more information and examples. | ||
groupsIDs string | Mandatory - Group identifiers for each list, separated by semicolons. You can specify multiple groups for each list as well, separated by commas. Example: | ||
importType integer | Mandatory - Import type.
Any empty field is ignored if importType is equal to 1,2 or 3
Any empty field overwrites the value on MailUp if importType is equal to 4, 5 or 6
| ||
mobileInputType integer | Mandatory - Mobile number input type.
(See "XML Structure" section below for more information and examples.) | ||
asPending boolean | optional Mandatory - Import recipients as If "pending" when set to true. (Default = false) | ConfirmEmail boolean | optional - Sends a confirmation request email when set to true. The system will automatically create the confirmation email based on a default template.true" subscribes (or unsubscribes, if "asOptOut=true") also the recipients that were pending in specified MailUp list before import. Please note that the name of this parameter is misleading, see table in Best Practices for details (Default = false) |
asOptOutConfirmEmail boolean | optional Mandatory - Imports recipients asIf " unsubscribed" when set to truetrue" sets subscription status of specified recipients as "pending" and sends them a confirmation email. Status change to "pending" and email sending applies to either brand new recipients or to recipients that were already subscribed or pending to the specified list before import. See table in Best Practices for details. | ||
forceOptInasOptOut boolean | optional Mandatory - Imports recipients as "subscribedunsubscribed" when set to true. This will re-subscribe recipients that have previously unsubscribed "true", regardless if they were previously subscribed into specified MailUp list. If you want to cancel subscription (i.e. unsubscribe) also for the recipients that were previously pending, you should set both "asOptOut=true" and "asPending=true". See table in Best Practices for details. (Default = false) | ||
forceOptIn boolean | optional - Replace existing groups when set to true. The system will automatically remove previously subscribed groups and keep only the groups specified in the groupsIDs parameter.(Default = false) |
...
Mandatory - If true enables change of subscription status even if a recipient was "unsubscribed" before import. It can be used to force "subscribed" or "pending" status for previously unsubscribed recipients, please note that this status change does not apply when recipient was automatically unsubscribed due to hard bounce or complaints feedback loop. See table in Best Practices for details. (Default = false) | |
replaceGroups boolean | Mandatory - Replace existing groups when set to true. The system will automatically remove previously subscribed groups and keep only the groups specified in the groupsIDs parameter.(Default = false) |
Note | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
The following table shows the most common combinations for the parameters that manage subscription status of imported recipients that are already present on MailUp
|
Tip | ||
---|---|---|
| ||
|
...
Code Block | ||||
---|---|---|---|---|
| ||||
<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 values are provided for both listsIDs
and listsGUIDs
parameters (mandatory fields). Each of the parameters must have the same number of elements (separated by semi-colons). In this case, we are also specifying group 22 for list 1, and group 13 for list 2.
Code Block | ||||
---|---|---|---|---|
| ||||
<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> |
...
Code Block | ||||
---|---|---|---|---|
| ||||
<?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); ?> |
C#
Code Block | ||
---|---|---|
| ||
WSMailUpImport toTest = new WSMailUpImport(); Authentication auth = new Authentication(); auth.User = tbLoginUserImport.Text; auth.Password = tbLoginPasswordImport.Text; auth.encType = string.Empty; toTest.AuthenticationValue = auth; string xmlString = "<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></subscribers>"; string myListId = "8"; string myListGuid = "CC9C4CBD-567B-4248-B56F-7C8364F11C5"; string myGroupsIDs = "45"; int importType = 3; int mobileInputType = 2; bool asPending = false; bool ConfirmEmail = false; bool asOptOut = false; bool forceOptIn = false; bool replaceGroups = false; string retVal = toTest.StartImportProcesses(myListId ,myListGuid, xmlString, myGroupsIDs, importType, mobileInputType, asPending , ConfirmEmail, asOptOut, forceOptIn, replaceGroups); |
...