Sign in

v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB
Email Campaigns

Export the recipients of an email campaign

post/emailCampaigns/{campaignId}/exportRecipients

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

Example request

{
  "notifyURL": "http://requestb.in/173lyyx1",
  "recipientsType": "openers"
}

Response

Recipient export request has been accepted

processIdinteger required

Id of the process created

Example response

{
  "processId": 78
}