Update a campaign's status | Brevo API Documentation

Update the status of an SMS campaign, such as suspending, archiving, or replicating it. Available status values include suspended, archive, darchive, sent, queued, replicate, replicateTemplate, cancel, and draft. Note that the replicateTemplate status is only available for template type campaigns.

Authentication

api-keystring

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

Path parameters

campaignIdlongRequired

id of the campaign

Request

Status of the campaign.

statusenumOptional

Note:- replicateTemplate status will be available only for template type campaigns.

Response

The campaign status has been updated successfully

Errors

400

Bad Request Error

404

Not Found Error

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

Status of the campaign.

Note:- replicateTemplate status will be available only for template type campaigns.

The campaign status has been updated successfully

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.updateSmsCampaignStatus(1, {
8	body: {},
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.updateSmsCampaignStatus(1, {
8	body: {},
9	});
10	}
11	main();