WSMailUpImport.NewImportProcess method

Method parameters

NewImportProcess(int idList, int listGUID, idGroup, string xmlDoc, string idGroups, int importType,
int mobileInputType, bool asPending, bool ConfirmEmail, bool asOptOut, bool forceOptIn,
bool replaceGroups, int idConfirmNL)

Creates a new import process for the contacts listed in the xmlFeed.

• idList: list identifier
• listGuid: GUID of the list
• xmlDoc: an XML string containing the contacts to be imported (see paragraph "XML feed" below)
• idGroups: group identifiers separated by comma (more than a group for each list is possible)
• importType: import type (default value=3)
• mobileInputType: mobile number input type ((see paragraph "XML feed" below)
  • 1= include international code
  • 2= international code and phone number in two different fields
• asPending: subscribes users as pending, if true (default value=false)
• ConfirmEmail: sends confirmation request email (default value=false)
• asOptOut: imports users as unsubscribed (default value=false)
• forceOptIn: forces subscription of users (default value=false)
• replaceGroups: replaces groups (default value=false)
• idConfirmNL: confirmation newsletter ID (default value=0, confirmation request created automatically)
  
  

If the import process is created successfully, then an "idProcess" value identifying it is returned; if not, a ReturnCode is returned.

Sample ReturnCode

<mailupMessage>
<mailupBody>
<ReturnCode>17</ReturnCode>
</mailupBody>
</mailupMessage>

Error codes

<subscribers>
<subscriber email="user@myprovider.com" Prefix="+001" Number="8889624587" Name="">
<campo1>first name</campo1>
<campo2>last name</campo2>
<campo3>Nweb SRL</campo3>
</subscriber>
</subscribers>

<subscriber email="user@myprovider.com" Prefix="" Number="+0018889624587" Name="">

<subscriber email="user@myprovider.com" Prefix="+001" Number="8889624587" Name="">

# Refer to https://mailup.atlassian.net/wiki/display/mailupapi/MailUp+RubyGem for gem information.
require 'mailup'
m = MailUp::Import.new('username', 'password', 'console_url')
m.new_import_process(:listID => 123456, :listGuid => 123456, :xmlDoc => "XML_STRING", ...)
# => <?xml version=\"1.0\" encoding=\"windows-1252\" ?><mailupMessage><mailupBody><ReturnCode>17</ReturnCode></mailupBody></mailupMessage>