contacts

Export contacts

It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv.

post/contacts/export

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/contacts/export
  • Auth: API key in header api-key

Request body

disableNotificationboolean

To avoid generating the email notification upon contact export, pass true

exportAttributesstring[]

List of all the attributes that you want to export. **These attributes must be present in your contact database. It is required if exportMandatoryAttributes is set false. ** For example: ['fname', 'lname', 'email']

exportMandatoryAttributesboolean

To export mandatory attributes like EMAIL, ADDED_TIME, MODIFIED_TIME

exportMetadatastring[]

Export metadata of contacts such as _listIds, ADDED_TIME, MODIFIED_TIME.

exportDateInUTCboolean

Specifies whether the date fields createdAt, modifiedAt in the exported data should be returned in UTC format.

exportSubscriptionStatusstring[]

Export subscription status of contacts for email & sms marketting. Pass email_marketing to obtain the marketing email subscription status & sms_marketing to retrieve the marketing SMS status of the contact.

notifyUrlstring url

Webhook that will be called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479

Response

process id created

processIdinteger required

Id of the process created

Changes

No recorded changes to this operation across all 1 revision of this API.