API reference
Help CenterCommunityDevelopersAcademyStatus

Export from a database - ExportList

Used to export contact data from an Acoustic Campaign database, query, or contact list.

Acoustic Campaign exports the list results to a .CSV file, then adds that file to the FTP account associated with the current session. You can copy the results file to the Stored Files in Acoustic Campaign.

📘

Note

If the database is a Double Opt-in database, Acoustic Campaign exports only confirmed contacts. By default, the database security settings for this operation are disabled for all Double Opt-in databases.

Required elements

LIST_ID - Unique identifier for the database, query, or contact list Acoustic Campaign is exporting.

EXPORT_TYPE - Specifies the contacts to export. Valid values are: ALL (exports the entire database), OPT_IN (exports only currently opted-in contacts), OPT_OUT (exports only currently opted-out contacts), and UNDELIVERABLE (exports only contacts currently marked as undeliverable).

EXPORT_FORMAT - Specifies the file format for the exported date: CSV (creates a comma-separated values file), TAB (creates a tab-separated values file), or PIPE (creates a pipe-separated values file).

Optional elements: columns

By default, all columns from the database are exported except for Recipient ID and Lead Source. To add these columns, you must include the INCLUDE_LEAD_SOURCE and INCLUDE_RECIPIENT_ID elements to the body of your request.

To export a custom selection of columns, specify all columns you need in the EXPORT_COLUMNS element.

ElementChild elementValuesDefinition
INCLUDE_LEAD_SOURCEBoolean To export the Lead Source column, set the value to true.
INCLUDE_RECIPIENT_IDBoolean To export the Recipient ID column, set the value to true.
EXPORT_COLUMNSCOLUMNString.

Values for system columns:

- CRM Account ID
- CRM Contact Type
- CRM Enable Sync
- CRM Lead Source
- CRM Sync ID
- Email
- Email Type
- Opt-In Date
- Opt-In Details
- Opt-Out Details
- Opted-Out
- Opted-Out Date
- RECIPIENT_ID
- Last Modified Date		The names of custom and system columns to export. Each column requires a separate entry.

Other optional elements

EMAIL - The email address to receive notifications when the job is complete.

FILE_ENCODING - Defines the encoding of the exported filed. Valid values are utf-8 and iso-8859-1. If not specified, Acoustic Campaign uses the organization default encoding.

ADD_TO_STORED_FILES - Writes the output to the Stored Files folder in Acoustic Campaign. If omitted, Acoustic Campaign moves exported files to the download directory of the user's FTP space.

DATE_START - Specifies the beginning boundary of information to export (relative to the last modified date). If time is included, it must be in 24-hour format.

DATE_END - Specifies the ending boundary of information to export (relative to the last modified date). If time is included, it must be in 24-hour format.

USE_CREATED_DATE - If included, the DATE_START and DATE_END range are relative to the contact's create date rather than last modified date. Note: The contact's create date might not be the same as the contact's opted-in date.

LIST_DATE_FORMAT - Specifies the date format of the date fields in your exported file if date format differs from "mm/dd/yyyy" (month, day, and year can be in any order you choose). Separators can be up to two characters in length and can consist periods, commas, question marks, spaces, and forward slashes (/).

Valid Month values:

  • M (i.e. 1)
  • MM (i.e. 01)
  • MMM (i.e. Jan)
  • MMMM (i.e. January)

Valid Day values:

  • d (i.e. 2)
  • dd (i.e. 02)

Valid Year values:

  • yy (i.e. 99)
  • yyyy (1999)

Examples:

  • For date "Jan 2, 1975", your LIST_DATE_FORMAT is "MMM d, yyyy".
  • For date "1975/01/02", your LIST_DATE_FORMAT is "yyyy/MM/dd".
<Envelope>
  <Body>
    <ExportList>
      <LIST_ID>59294</LIST_ID>
      <EXPORT_TYPE>ALL</EXPORT_TYPE>
      <EXPORT_FORMAT>CSV</EXPORT_FORMAT>
      <ADD_TO_STORED_FILES/>
      <DATE_START>06/25/2017 01:00:00</DATE_START>
      <DATE_END>06/28/2017 23:59:59</DATE_END>
      <EXPORT_COLUMNS>
        <COLUMN>FIRST_NAME</COLUMN>
        <COLUMN>INITIAL</COLUMN>
        <COLUMN>LAST_NAME</COLUMN>
      </EXPORT_COLUMNS>
    </ExportList>
  </Body>
</Envelope>

<Envelope>
  <Body>
    <RESULT>
      <SUCCESS>TRUE</SUCCESS>
      <JOB_ID>135477159</JOB_ID>
      <FILE_PATH>Primary List - All - u78ar - Jun 19 2022 10-30-01-735 AM.csv</FILE_PATH>
    </RESULT>
  </Body>
</Envelope>

Response elements

SUCCESS - True if successful, False if not.

JOB_ID - Identifies the Acoustic Campaign background job created and scheduled for this import.

FILE_PATH - Identifies the file name of the exported file. The filename format is <List or query name> - <ExportType> -<alphanumeric string> - <Date>.<File Type>
For example: Primary List - All - u78ar - Jun 19 2022 10-30-01-735 AM.csv

Where

  • u78ar – is a 5-character alphanumeric random string.
  • -735– is milliseconds in the date format.

📘

Note:

The alphanumeric string and the milliseconds in the date format help prevent issues when there are multiple exports and may share the same filename.