Use this endpoint to create asynchronous background jobs that exports the members of a specified contact list to a comma separated value (CSV) file.
Click a method to view its documentation
Privileges required: contacts:write
Export the members of a contact list to a RFC 4180 compliant .CSV file. In the JSON request body you need to specify the following properties:
See the Structure section for details and values for these properties.
column_names array lists the contact properties to include in the exported file. See the JSON Structure table below for valid column names to use. If the first contact does not have a valid email address, then the request fails and no contacts are exported. "Email" must be included in
column_names, or the activity will fail.
The following columns names have been deprecated for export as of the May 5, 2014 update:
Existing integrations using these column names will not return errors, but the API ignores these columns.
You can export the following system generated contact lists that are filtered by contact
status by specifying them as follows in the lists array (include only a single list in the array):
status definitions here.
You can poll the URI returned in the response's location header to monitor the status of the export activity. You must include the access_token and api_key when making a GET call to the activity status report endpoint:
The activity has finished once the status is returned as either COMPLETE or ERROR. The activity status response structure is detailed here.
Once the activity completes processing (status = COMPLETE or ERROR in the activity status report), the status report will also include the
file_name property, which is the URL where the file is hosted. The value of this property is a URI that points to the location of the exported file. To retrieve the file, make a GET call to the URI, be sure to include the access_token and api_key in the call.