Sign in

v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB
SMS Campaigns

Export an SMS campaign's recipients

It returns the background process ID which on completion calls the notify URL that you have set in the input.

post/smsCampaigns/{campaignId}/exportRecipients

Path parameters

campaignIdinteger required

id of the campaign

Request body

notifyURLstring url

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

recipientsType'all' | 'delivered' | 'answered' | 'softBounces' | 'hardBounces' | 'unsubscribed' required

Filter the recipients based on how they interacted with the campaign

Example request

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

Response

Recipient export request has been accepted

processIdinteger required

Id of the process created

Example response

{
  "processId": 78
}