Export the recipients of an email campaign

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

campaignIdlongRequired
Id of the campaign

Request

Values to send for a recipient export request
recipientsTypeenumRequired
Type of recipients to export for a campaign
notifyURLstringOptionalformat: "url"
Webhook called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479

Response

process id created
processIdlong
Id of the process created

Errors