WhatsApp Campaigns

Learn how to integrate WhatsApp Campaigns

Here you will find an overview of the WhatsApp Campaigns API. Currently, the actions available are fetching details of your WhatsApp campaigns or you can delete a WhatsApp campaign through the endpoints. You can check the endpoints on the Sendinblue API reference site at API Reference > WhatsApp campaigns.

Requirements

To create and manage your Whatsapp campaigns you need to have access to the WhatsApp Campaigns app. If you have not already activated the WhatsApp platform on your account you can go to Whatsapp Campaigns > Activating WhatsApp Campaigns.

Get WhatsApp campaign

You can call the endpoint https://api.sendinblue.com/v3/whatsappCampaigns/{campaignId} with the method GET. The cURL request for the endpoint is:

curl --request GET \
     --url https://api.sendinblue.com/v3/whatsappCampaigns/465908589032810 \
     --header 'accept: application/json' \
     --header 'api-key: '

This endpoint only has one attribute which is mentioned in the table below:

AttributeDatatypeDescriptionValue
campaignIdStringId of the campaign465908589032810

Responses

Response codeMessageDescription
200Whatsapp campaign overviewWhatsapp campaign details displayed.
400Bad requestRequest parameters not in correct format.
404CampaignId not foundCampaign id is incorrect or it cannot be accessed from the Whatsapp campaigns dashboard.

Delete a WhatsApp campaign

You can call the delete Whatsapp endpoint at https://api.sendinblue.com/v3/whatsappCampaigns/{campaignId} with method DELETE. The cURL request for this endpoint is as follows:

curl --request DELETE \
     --url https://api.sendinblue.com/v3/whatsappCampaigns/465908589032810 \
     --header 'accept: application/json' \
     --header 'api-key: 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'

To delete a Whatsapp campaign, you need your campaign id. Notice this won't delete an ongoing campaign**

AttributeDatatypeDescriptionValue
campaignIdStringId of the campaign465908589032810

πŸ“˜

How can you get your campaignId?

You can retrieve the campaignId from the Sendinblue WhatsApp dashboard and use it in the API endpoint.


Responses

Response codeMessageDescription
204Whatsapp campaign has been deletedWhatsapp campaign details displayed.
400Bad requestRequest parameters not in correct format.
404CampaignId not foundCampaign id is incorrect or it cannot be accessed from the Whatsapp campaigns dashboard.