legacy.bulk_sync

email

The email address of the subscriber (260 characters max)

external_id

The subscriber's identifier is defined within an external system. This ID must be unique across all subscribers (64 characters max).

firstname

The subscriber's first name (260 characters max)

lastname

The subscriber's last name (260 characters max)

address

Street address (1000 characters max)

city

City name (1000 characters max)

state

State or province (250 characters max)

country

Country name or ISO code (250 characters max)

postal_code

Postal code (30 characters max)

phone_hm

Home phone number (50 characters max)

phone_wk

Work phone number (50 characters max)

fax

Fax number (50 characters max)

epref

A one-letter code defining the subscriber's email address preference as:

• P – plain text

• H – HTML

• N – No preference

tz_id

Time zone identifier

custval NNNN

A custom field that exists within the system where NNNN is the custom field ID to be referenced. To view a list of custom fields and their corresponding ID numbers, log in to the application and navigate to Assets > Manage Custom Fields. Scroll down on the screen to the Custom Fields section to find the custom field name and its corresponding custom field ID.

customfieldss NNNN

A custom field that exists within the system where NNNN is the custom field ID to be referenced. To view a list of custom fields and their corresponding ID numbers, log in to the application and navigate to Assets > Manage Custom Fields. Scroll down on the screen to the Custom Fields section to find the custom field name and its corresponding custom field ID.

This column is only included for backward compatibility. All references to custom fields should use the custval NNNN notation.

customdatefld NNNN

A custom date field that exists within the system where NNNN is the custom field ID to be referenced. To view a list of custom fields and their corresponding ID numbers, log in to the application and navigate to Assets > Manage Custom Fields. Scroll down on the screen to the Custom Fields section to find the custom field name and its corresponding custom field ID. The date must be in the format YYYY-MM-DD.

This column is only included for backward compatibility. All references to custom fields should use the custval NNNN notation.

reply_email

The email address which will receive the email confirmation when the bulk synchronization is complete

string

Yes

jsmith@example.com

ignore_existing

Specifies whether to update existing records in the database with the information provided in the data file where:

• 0 – Do not ignore existing subscriber contact records. Any record that already exists in the subscriber database will be updated with the information provided in the data file. (default)

• 1 – Ignore existing subscriber contact records. Any record that already exists in the subscriber database will not be updated with the information provided in the data file. This is the Add Only option.

boolean

No

1

ignore_new

Specifies whether to create records in the database with the information provided in the data file where:

• 0 – Do not ignore new subscriber contact records. Contact records for subscribers that are new to the database will be created. (default)

• 1 – Ignore new subscriber contact records. Any record that does not exist in the subscriber database will not be created with the information provided in the data file.

boolean

No

1

grp

A comma-delimited list of the ID numbers of the static segments to which this subscriber should be added as a member. To view a list of static segments and their corresponding ID numbers, log in to the application and navigate to Segmentation > Manage Static Segments. Scroll down on the screen to the Segments section to find the static segment name and its corresponding segment ID.

string

No

34982,93833

clear_grp

Including a comma-delimited list of static segment ID numbers in this element will remove all subscribers from the static segments referenced here. Including a static segment ID in both the <clear_grp> element and the <grp> element has the effect of completely emptying the membership of the static segment prior to repopulating it with the subscribers being uploaded in the data file. As a shortcut for resetting the membership of static segments, include a comma-delimited list of static segment IDs in the <grp> element and pass the value of 'Y' for the <clear_grp> element.

To view a list of static segments and their corresponding ID numbers, log in to the application and navigate to Segmentation > Manage Static Segments. Scroll down on the screen to the Segments section to find the static segment name and its corresponding segment ID.

string

No

34982,12345 or Y

welcome_letter

Applies only to new subscriber records. Specifies whether to send the new subscriber a welcome letter. If <doi>1</doi> is also included in the XML payload, the subscriber will receive the welcome letter after confirming the double opt-in request.

• 0 – do not send a welcome letter (default)

• 1 – send a welcome letter

boolean

No

1

doi

Applies only to new subscriber records. Specifies whether to send the new subscriber a standard Opt-in confirmation email. Only when the message recipient confirms will the record be marked as a subscriber.

• 0 – follow the account default setting for Double Opt-in (default)

• 1 – send the Double Opt-in email regardless of the account's default setting

boolean

No

1

file_type

Specifies the import file type. Acceptable values are:

• comma – indicates that columns are separated by commas

• tab – indicates that columns are separated by tabs

• zipcomma – indicates that the file is a comma-delimited file that is ZIP compressed

• ziptab – indicates that the file is a tab-delimited file that is ZIP compressed

• gzipcomma – indicates that the file is a comma-delimited file that is GZIP compressed

• gziptab – indicates that the file is a tab-delimited file that is GZIP compressed

• custom – indicates that columns are separated by a custom delimited specified by the <custom_delimiter> element (see below).

string

Yes

ziptab

number

An integer that indicates the number of data columns within the file

number

Yes

13

source

A text string that indicates where the list came from. This will only be applied to new subscribers, and it will be available to them for spam complaint prevention.

string

Yes

These subscribers dropped their business cards in a fishbowl.

custom_delimiter

A text character indicating the custom text delimiter being used.

string

Conditional; required if <file_type>custom</file_type> is included in XML payload

|

data_url

The URL of the data source located on the Internet. Allowable file extensions are .txt, .csv or .zip

string

Conditional; required if not using FTP as the transfer protocol

https://www.mysite.com/data/segment5.csv

ftp_server

IP address or hostname of your FTP server

string

Conditional; required if file transfer is via FTP

ftp.mysite.com

ftp_user_name

FTP username

string

Conditional; required if file transfer is via FTP

ftp_user

ftp_user_pass

FTP password

string

Conditional; required if file transfer is via FTP

ftp_pass

filename

The name of the data file on the FTP server (may include file path). Allowable file extensions are .txt, .csv or .zip

string

Conditional; required if file transfer is via FTP

datafile.txt or /path/to_file/datafile.txt

sftp

Indicator of whether the connection is via the sFTP protocol where:

• 0 – Do not connect via sFTP (default)

• 1 – Connect via sFTP

NOTE: If both <sftp>1<sftp> and <ftp_ssl>1</ftp_ssl> are included in the XML payload, then the connection will be via sFTP protocol. If the sFTP port is something other than 22, the port number should be specified in the ftp_server parameter preceded with a colon (e.g sftp.myftpserver.com:2222)

boolean

No

1

ftp_ssl

Indicator of whether FTP with a valid SSL certificate should be applied where:

• 0 – Do not apply SSL certificate (default)

• 1 – Apply SSL certificate

boolean

No

1

message

A code indicating either a success or a failure of the bulk sync

1

task_id

Use the value returned in this XML element as one of the input parameters for the utilities.getTasks method call in order to retrieve the current status of the bulk sync job.

123456

list_id

This element only appears in the response message in the case of a successful bulk sync. It corresponds to the internal ID of the list that has been successfully loaded.

58605

reason

This element only appears in the response message in the case of a failed bulk sync. It will contain a human-readable explanation of the reason for failure.

file must contain email column

201

Result: Submitted import (list ID <LIST_ID>)

Successful submission of a file to be uploaded into your subscriber database.

401

invalid file_type variable

The value of the <file_type> element is not one of the acceptable values.

402

data source not specified

Elements specifying the location of the upload file are missing from the request.

403

filename or data_url not passed

The <filename> element or the <data_url> element is missing from the request.

404

can't create the folder

There was a problem encountered when attempting to upload the file into Mapp.

405

not all variables passed through

Incomplete set of elements included in the request that is necessary.

406

unique identifier feature must be enabled

The data file included the external_id column header, but your account is not enabled for the Unique identifier feature.

407

Non-integer values in clear_grp

The <clear_grp> element included non-numeric values (other than the comma character, or the 'Y' character)

408

error in the file upload process

There was a problem encountered when attempting to upload the file into Mapp

409

Cannot create a bulk_sync job, please try again later

There was a problem encountered in the process.