smsCampaigns

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

Request

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

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

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.