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".
...
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: |
xmlDoc | An XML string containing the recipients to be imported to the specified lists and groups. (See "XML Structure" section below for known restrictions, more information and examples.) |
groupsIDs string | Group identifiers for each list, separated by semicolons. You can specify multiple groups for each list as well, separated by commas. Example: |
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> |
...
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=""> |
An example XML subscriber is represented below (note the empty tags for all data fields below 11)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 | ||||
---|---|---|---|---|
| ||||
<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.
...