emailCampaigns

Export the recipients of an email campaign

Export the recipients of a sent email campaign as an asynchronous process, filtered by recipient type (e.g. openers, clickers, hardBounces). The recipientsType field is required and determines which subset of recipients to export. An optional notifyURL webhook will be called once the export is complete, and the response returns a processId to track the export status.

post/emailCampaigns/{campaignId}/exportRecipients

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/emailCampaigns/{campaignId}/exportRecipients
  • Auth: API key in header api-key

Path parameters

campaignIdinteger required

Id of the campaign

Request body

notifyURLstring url

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

recipientsType'all' | 'nonClickers' | 'nonOpeners' | 'clickers' | 'openers' | 'softBounces' | 'hardBounces' | 'unsubscribed' required

Type of recipients to export for a campaign

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.