Export contacts

post

https://api.brevo.com/v3/contacts/export

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Some contact filter examples are given below-

Body Params

Values to request a contact export

customContactFilter

object

required

Set the filter for the contacts to be exported.

disableNotification

boolean

Defaults to false

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

exportAttributes

array of strings

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']

exportAttributes

exportMandatoryAttributes

boolean

Defaults to true

To export mandatory attributes like EMAIL, ADDED_TIME, MODIFIED_TIME

exportMetadata

array of strings

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

exportMetadata

exportDateInUTC

boolean

Defaults to false

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

exportSubscriptionStatus

array of strings

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.

exportSubscriptionStatus

notifyUrl

url

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

Responses

202process id created

400bad request

429Too Many Requests