v1

latestOpenAPI 3.0.3MIT2026-07-1410794124.7 KB
Contacts

Export Contacts

Request an Export of specified Contacts. Required Access Level: Export

post/contacts/export

Query parameters

fileFormat'Csv' | 'Xml' | 'Json'

Format of the exported file.

Format of the exported file

rulestring string

string

Example:Status%20=%20Engaged

Query used for filtering.

emailsstring[]

array

Comma delimited list of contact emails

[
  "mail@contact.com,mail1@contact.com,mail2@contact.com"
]
compressionFormat'None' | 'Zip'

FileResponse compression format

FileResponse compression format. None or Zip.

fileNamestring string

string

Example:filename.txt

Name of your file including extension.

Response

Accepted

Linkstring string

Direct URL to the exported file

PublicExportIDstring guid

ID of the exported file

Example response

{
  "PublicExportID": "E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F"
}