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: one of:
    • API key in header api-key
    • API key in header partner-key

Request body

exportAttributesstring[]

List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email'].

notifyUrlstring url

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

Example request

{
  "exportAttributes": [
    "NAME"
  ],
  "customContactFilter": {
    "listId": 2,
    "emailCampaignId": 12,
    "smsCampaignId": 12
  },
  "notifyUrl": "http://requestb.in/173lyyx1"
}

Response

Contact export request has been accepted

processIdinteger required

Id of the process created

Example response

{
  "processId": 78
}

Changes

No recorded changes to this operation across all 2 revisions of this API.