WSMailUpImport.StartProcess

Owned by Massimo Arrigoni (Unlicensed)
Last updated: Dec 05, 2012 by MailUp Dev Team (Unlicensed)Version comment
1 min read

Starts the import process that has been created using NewImportProcess method

Method parameters

StartProcess(int idList, int listGUID, int idProcess)

Starts the import process

  • idList: list identifier
  • listGuid: GUID of the list
  • idProcess: import process ID


If the process cannot be activated the result will contain an appropriate ReturnCode.

Sample ReturnCode

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

Error codes

Error codeDescription
-600unrecognized error
-601an import process is already running for the list
-602an import process is already running for a different list
-603error checking process status
-604error starting the process job

Ruby Example

# 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.start_proces(:idList => 123456, :listGuid => 123456, :idProcess => 123)
# => <?xml version=\"1.0\" encoding=\"windows-1252\" ?><mailupMessage><mailupBody><ReturnCode>0</ReturnCode></mailupBody></mailupMessage>