Overview

The Contact Exports resource creates an export job to download and store a file of contacts from the Cordial database.

• API Set Name: contactexports

Additional information

• This resource uses the JSON request information to define the target host location of the file, the transport protocol, the external host login authentication information, and the fields to include in the file.
• It is important to note that this resource is not a collection of exports, but it is a resource that initiates export processing by creating an export job.
• Export status information is available through the "jobs" resource. To access the Jobs page via UI, click on the   icon at the top right of the application header.
• Export supports file types "CSV" and "JSON".
• Export files in the UI will be stored for 30 days from the date of the export.

POST /contactexports

Parameters

* Required

1.) If nofields lists parameters are passed (or passed with empty array values), allfields and lists will be returned in the file. 2.) If the lists parameter is passed with array values, and no fields parameter is passed (or passed with empty array values), the email field and designated list values will be returned in the file.

Examples

Cordial UI

The following will initiate an export job of a CSV file containing all contacts and all fields, downloadable via the UI on the Jobs page.

{
    "exportType": "csv",
    "name": "contactExport",
    "destination": {
        "type": "aws"
    },
    "showHeader": true,
    "confirmEmail": "msmith@example.com"
}

FTP/SFTP

The following will initiate an export job of a CSV file via SFTP containing all contacts and two fields.

{
    "exportType": "csv",
    "name": "contactExport",
    "destination": {
        "type": "sftp",
        "server": "example.com",
        "port": "21",
        "username": "username",
        "password": "password",
        "path": "/"
    },
    "showHeader": true,
    "fields": [
        "channels.email.address",
        "first_name"
    ],
    "confirmEmail": "msmith@example.com"
}

Amazon S3

The following will initiate an export job of all contacts in the "30_day_engaged" audience, 2 fields and 2 lists into a CSV file via Amazon S3. In this example, the file will be uploaded to s3://my_bucket/folder.

{
  "exportType": "csv",
  "name": "myExportFilename",
  "destination": {
    "type": "s3",
    "aws_access_key_id": "A1234567890",
    "aws_secret_access_key": "B1234567890",
    "aws_bucket": "my_bucket",
    "aws_region": "us-west-2",
    "path": "folder"
  },
  "showHeader": true,
  "audience-key": "30_day_engaged",
  "fields": [
    "channels.email.address",
    "channels.email.subscribeStatus"
  ],
  "lists": [
    "monthly_newsletter",
    "first_name"
  ],
  "confirmEmail": "msmith@example.com"
}

We recommend omitting the trailing slash right after your S3 path name to avoid duplicate slashes being added by default. For example, use folder instead of /folder/.

Google Cloud Storage (GCS)

The following will initiate an export job of a CSV file of all contacts in the "engaged-march" audience via Google Cloud Storage (GCS).

Your Google Could Storage integration must be enabled in the Cordial Marketplace.

{
    "exportType": "csv",
    "name": "contactExport",
    "destination": {
        "type": "gcs",
        "gcs_bucket": "bucketname",
        "path": "/contactexports"
    },
    "showHeader": true,
    "audience-key": "engaged-march",
    "confirmEmail": "emsmith@example.com"
}

Example request URI

The following URI in conjunction with the JSON will perform the POST.

http://<path>/contactexports