whatsAppCampaigns

Get 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>

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

Response

Get whatsApp campaign information on the basis of campaignId

campaignNamestring required

Name of the WhatsApp Campaign

campaignStatus'draft' | 'scheduled' | 'pending' | 'approved' | 'running' | 'suspended' | 'rejected' | 'sent' required

Status of the WhatsApp Campaign

createdAtstring required

Creation UTC date-time of the WhatsApp campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)

idinteger required

ID of the WhatsApp Campaign

modifiedAtstring required

UTC date-time of last modification of the WhatsApp campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)

scheduledAtstring

UTC date-time on which WhatsApp campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format

senderNumberstring required

Sender of the WhatsApp Campaign

Changes

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