Get a WhatsApp campaign | Brevo API Documentation

1 curl https://api.brevo.com/v3/whatsappCampaigns/1 \ 2 -H "api-key: <apiKey>"

1 { 2 "campaignName": "Test WhatsApp Campaign", 3 "campaignStatus": "sent", 4 "createdAt": "2022-12-26T06:50:00Z", 5 "id": 1672035851100690, 6 "modifiedAt": "2022-12-26T08:50:00Z", 7 "senderNumber": "9368207029", 8 "template": { 9 "button_type": "CALL_TO_ACTION", 10 "category": "MARKETING", 11 "components": [ 12 { 13 "text": "making it look like readable English.", 14 "type": "BODY" 15 }, 16 { 17 "type": "BUTTONS", 18 "buttons": [ 19 { 20 "text": "vLorem Ipsum is simply du", 21 "type": "URL", 22 "url": "app.brevo" 23 }, 24 { 25 "phone_number": "+918800613137", 26 "text": "Lorem Ipsum is simply dum", 27 "type": "PHONE_NUMBER" 28 } 29 ] 30 } 31 ], 32 "contains_button": true, 33 "display_header": false, 34 "header_type": "text", 35 "header_variables": [ 36 { 37 "datatype": "text", 38 "default": "INVALID HEADER", 39 "name": "FIRSTNAME", 40 "index": 1 41 } 42 ], 43 "language": "en", 44 "name": "official_campaign8", 45 "body_variable": [], 46 "header_footer": true 47 }, 48 "scheduledAt": "2022-12-27T09:50:00Z", 49 "stats": { 50 "delivered": 3, 51 "notSent": 4, 52 "read": 2, 53 "sent": 3, 54 "unsubscribe": 0 55 }, 56 "recipients": { 57 "excludedLists": [ 58 45 59 ], 60 "includedLists": [ 61 22 62 ], 63 "type": "list" 64 } 65 }

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> 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](https://developers.brevo.com/docs/whatsapp-campaigns-1) in your account </Note>

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

Response

Get whatsApp campaign information on the basis of campaignId

campaignNamestring

Name of the WhatsApp Campaign

campaignStatusenum

Status of the WhatsApp Campaign

createdAtstring

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

idlong

ID of the WhatsApp Campaign

modifiedAtstring

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

senderNumberstring

Sender of the WhatsApp Campaign

templateobject

scheduledAtstring or null

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

statsobject or null

Authentication

Path parameters

Response

Errors