Export an SMS campaign's recipients | Brevo API Documentation

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

api-keystring

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

campaignIdlongRequired

id of the campaign

Values to send for a recipient export request

recipientsTypeenumRequired

Filter the recipients based on how they interacted with the campaign

notifyURLstringOptionalformat: "url"

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

process id created

processIdlong

Id of the process created

400

Bad Request Error

404

Not Found Error

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.smsCampaigns.requestSmsRecipientExport(1, {
8	recipientsType: "answered",
9	});
10	}
11	main();

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.smsCampaigns.requestSmsRecipientExport(1, {
8	recipientsType: "answered",
9	});
10	}
11	main();