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".
...
Mandatory fields must be specified even when they are empty. Optional fields ( can be skipped if you want to use the default value) are written in in blue.
Parameter | |
---|---|
listsIDs | List identifiers. You can include multiple list IDs, separated by semicolons. Example: |
listsGUIDs string | List GUIDs. You can include multiple list GUIDs, separated by semicolons. Example: |
groupsIDs string | Group identifiers for each list, separated by semicolons. You can specify multiple groups for each list as well, separated by commas. Example: |
xmlDoc | An XML string containing the recipients to be imported to the specified lists and groups. (See "XML Structure" section below for more information and examples.) |
importType integer | Import type. (Default = 3) |
mobileInputType integer | Mobile number input type.
(See "XML Structure" section below for more information and examples.) |
asPending boolean | optional - Import recipients as "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. (Default = false) |
asOptOut boolean | optional - Imports recipients as "unsubscribed" when set to true. (Default = false) |
forceOptIn boolean | optional - Imports recipients as "subscribed" when set to true. This will re-subscribe recipients that have previously unsubscribed. (Default = false) |
replaceGroups 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) |
...
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, 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 | ||||||
---|---|---|---|---|---|---|
| ||||||
<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> |
...