whatsAppCampaigns

Update a WhatsApp campaign

<Note>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</Note> <Note>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</Note>

put/whatsappCampaigns/{campaignId}

Request

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

Path parameters

campaignIdinteger required

id of the campaign

Request body

campaignNamestring

Name of the campaign

campaignStatus'scheduled' | 'suspended'

Status of the campaign

rescheduleForstring

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

object required

Changes

No recorded changes to this operation across all 1 revision of this API.