Skip to navigation
Marketing CampaignsWhatsApp Campaigns

Update a WhatsApp campaign

View as Markdown
You can use this API for WhatsApp only if you have setup your WhatsApp account on Brevo platform. To setup your WhatsApp account, follow the steps in the guide below. Activating Whatsapp in your account
This API requires the List and Segment ids as recipients in Body params.You can use the below Contact endpoints to get the required information. Get all the Lists Get all the Segments

Authentication

api-keystring

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

OR
AuthorizationBearer

OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app’s client_id/client_secret for a short-lived Bearer token.

Path parameters

campaignIdlongRequired
id of the campaign

Request

Values to update a WhatsApp Campaign
campaignNamestringOptional
Name of the campaign
campaignStatusenumOptionalDefaults to scheduled
Status of the campaign
Allowed values:
recipientsobjectOptional

Segment ids and List ids to include/exclude from campaign

rescheduleForstringOptional

Reschedule the sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of campaign. **Prefer to pass your timezone in date-time format for accurate result.For example: 2017-06-01T12:30:00+02:00 Use this field to update the scheduledAt of any existing draft or scheduled WhatsApp campaign.

Response

WhatsApp campaign has been deleted

Errors

400
Bad Request Error