How can we help?

Export contacts

Overview

You can export contacts from Cordial with the UI or using the API.

Export contacts via the UI

Cordial allows you to export all contacts or a filtered set of contacts based on audience rules into a CSV file.

1. Navigate to a page in the UI where you can export contacts:

  • Contacts > Search Contacts
  • Contacts > Export Contacts
  • Contacts > Audience Rules
  • Data > Data Automations

2. From within the Audience Builder, choose to export all contacts or build a specific audience using audience rules. Learn more about creating an audience here.

3. To export the audience, click the Export button, or choose Export from the Actions menu.

4. Fill out the appropriate fields.

    • Export name: The name may only contain letters, numbers, and dashes.
    • Choose attribute columns: Select which attributes you would like included in the export.
      Note: channels.email.address is referred to as email in the dropdown.
      Tip: You can export all attributes and all lists by leaving attribute and list columns blank.
    • Choose list columns: Select which list association you would like included in the export.
    • Header: Select whether or not to include a header row in the export.
    • Compress: Select whether or not to compress the export file. If selected, the file is compressed using GZIP with the file extension ".gz" added to the filename.
    • Destination: Choose whether to download the file locally, send it to FPT/SFTP, Amazon S3, or Google Cloud storage.
    • Schedule: Choose whether to export immediately or on a recurring schedule.
      Note: Public key authentication can be used when the export destination is SFTP.

5. After exporting you will be taken the Jobs page, where you can download the export by hovering over the arrow.

Note: You can always access the Jobs page by clicking on the Jobs icon at the top of your Cordial Dashboard:  

Export contacts on a recurring interval

In Cordial, you can also export contacts on a recurring schedule.

1. For Schedule, choose Export on a recurring interval.

2. Input a name for the Export File Name field.

The Export File Name field supports Smarty, so you can use Smarty variables in the URL path. For example, you can use Smarty to render the current date at the time of the export using either the smarty.now function (set to UTC time) or the Smarty utility getNow, which gives you the ability to set the timezone. Learn more about date and timestamp variables here.

  • Example file names:
    • Using smarty.now: contacts_{$smarty.now|date_format:"%m-%d-%Y_%H:%M:%S"}
    • Using getNow utility: contacts_{$utils->getNow('America/Los_Angeles', "Y-m-d H:i:s")}

4. Select Schedule interval and set your desired interval.

5. Select the Start date and optional End date and click Save.

Note:
  • The End date is the last day that the export will run.
  • If Start date and End date are both in the past, the export will not run.

6. After clicking Save, you will be taken to the Data Automations page, where you can view, disable/enable, or remove a scheduled export.

Note: If Send file to FTP was selected during configuration, the exported file will be available on the designated FTP site once the export job is completed. If the Send file to FTP option was unchecked, the file download will be available on the Jobs page once completed.

Export contacts via the API

You also have the option to export contacts via the API. To learn more, read our article on exporting contacts via the API.

 

In the next article, you can learn how to delete contacts.

Comments

0 comments

Please sign in to leave a comment.