Skip to main content
POST
Create Contact Export

Authorizations

Authorization
string
header
required

Authenticate with Authorization: Bearer <token> using a user API token from Profile Settings. Available in Chatwoot v4.19.0 and later.

Path Parameters

account_id
integer
required

The numeric ID of the account

Body

application/json
column_names
string[]

Contact column names to export. Omitted or empty uses the default columns.

payload
object[]

Contact filters, using the same format as POST /contacts/filter. A non-empty payload takes precedence over label.

label
string

An existing account label to select contacts when payload is absent or empty. Empty selects all resolved contacts.

scope_name
string

Display name for the selection. Does not filter contacts.

Response

Export created and queued. The CSV becomes downloadable after processing completes.

id
integer
required
name
string
required
Example:

"Contacts - 2026-11-09"

data_type
enum<string>
required
Available options:
contacts
status
enum<string>
required
Available options:
pending,
processing,
completed,
failed
export_options
object
required

Validated body options with default columns filled in and duplicate columns removed.

processed_records
integer
required
downloadable
boolean
required
total_records
integer | null
error_message
string | null
initiated_by
object | null
created_at
string<date-time>
updated_at
string<date-time>
started_at
string<date-time> | null
completed_at
string<date-time> | null
artifacts_expired_at
string<date-time> | null
stalled
boolean
can_rerun
boolean