Introduction

Getting started

Messaging API

Emails
Transactional SMS
Inbound Parsing
Transactional WhatsApp
- Send a WhatsApp messagepost
- Get all your WhatsApp activity (unaggregated events)get

Marketing campaigns

Email Campaigns
SMS Campaigns
WhatsApp Campaigns

Contact management

Contacts

events

Event
- Create an eventpost

Accounts and settings

Senders
Domains
Webhooks
Account
- Get your account information, plan and credits detailsget
- Get user activity logsget
Master account
User
Process
- Return all the processes for your accountget
- Return the informations for a processget
External Feeds

Sales CRM

Companies
Deals
Tasks
Notes
Files

Brevo API

Conversations

Tracker

Restful endpoints

Ecommerce

Ecommerce
Coupons
Payments

Loyalty

Program
Reward
Balance
Tier

Get a WhatsApp campaign

get https://api.brevo.com/v3/whatsappCampaigns/{campaignId}

URL Expired

The URL for this request expired after 30 days.

📘
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

Path Params

campaignId

int64

required

Id of the campaign

Responses

Response body

object

int64

required

ID of the WhatsApp Campaign

campaignName

string

required

Name of the WhatsApp Campaign

campaignStatus

string

required

Status of the WhatsApp Campaign

draft scheduled pending approved running suspended rejected sent

scheduledAt

string

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

senderNumber

string

required

Sender of the WhatsApp Campaign

stats

object

sent

integer

required

delivered

integer

required

read

integer

required

unsubscribe

integer

required

notSent

integer

required

template

object

required

name

string

name of the template

category

string

description of the template

language

string

language of the template

contains_button

boolean

display_header

boolean

header_type

string

type of header

components

array of objects

array of component item objects

components

object

type

string

text

string

header_variables

array of objects

array of variables item object

header_variables

object

name

string

default

string

datatype

string

body_variables

array of objects

array of variables item variables

body_variables

object

name

string

default

string

datatype

string

button_type

string

hide_footer

boolean

createdAt

string

required

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

modifiedAt

string

required

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

Response body

object

code

string

required

Error code displayed in case of a failure

invalid_parameter missing_parameter out_of_range campaign_processing campaign_sent document_not_found not_enough_credits permission_denied duplicate_parameter duplicate_request method_not_allowed unauthorized account_under_validation not_acceptable bad_request unprocessable_entity

message

string

required

Readable message associated to the failure

Response body

object

code

string

required

Error code displayed in case of a failure

message

string

required

Readable message associated to the failure

Updated 21 days ago

Send an SMS campaign's report

Delete a WhatsApp campaign

Did this page help you?

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.brevo.com/v3/whatsappCampaigns/campaignId \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 21 days ago

Send an SMS campaign's report

Delete a WhatsApp campaign

Did this page help you?

Introduction
Getting started

Messaging API
Emails
Delete hardbouncespost
Unblock an existing domain from the list of blocked domainsdelete
Add a new domain to the list of blocked domainspost
Get the list of blocked domainsget
Get the list of blocked or unsubscribed transactional contactsget
Unblock or resubscribe a transactional contactdelete
Get all your transactional email activity (unaggregated events)get
Get your transactional email activity aggregated per dayget
Get your transactional email activity aggregated over a period of timeget
Get scheduled emails by batchId or messageIdget
Delete scheduled emails by batchId or messageIddelete
Get the list of email templatesget
Get the personalized content of a sent transactional emailget
Get the list of transactional emails on the basis of allowed filtersget
Send a transactional emailpost
Transactional SMS
Get all your SMS activity (unaggregated events)get
Get your SMS activity aggregated per dayget
Get your SMS activity aggregated over a period of timeget
Send SMS message asynchronously to a mobile numberpost
Inbound Parsing
Retrieve inbound attachment with download token.get
Fetch all events history for one particular received email.get
Get the list of all the events for the received emails.get
Transactional WhatsApp
Get all your WhatsApp activity (unaggregated events)get
Send a WhatsApp messagepost

Marketing campaigns
Email Campaigns
Upload an image to your account's image gallerypost
Export the recipients of an email campaignpost
Get a shared template urlget
Get an A/B test email campaign resultsget
Send the report of a campaignpost
Update an email campaign statusput
Send an email campaign to your test listpost
Send an email campaign immediately, based on campaignIdpost
Delete an email campaigndelete
Update an email campaignput
Get an email campaign reportget
Create an email campaignpost
Return all your created email campaignsget
SMS Campaigns
Send an SMS campaign's reportpost
Export an SMS campaign's recipientspost
Send a test SMS campaignpost
Update a campaign's statusput
Send your SMS campaign immediatelypost
Delete an SMS campaigndelete
Update an SMS campaignput
Get an SMS campaignget
Creates an SMS campaignpost
Returns the information for all your created SMS campaignsget
WhatsApp Campaigns
Get your WhatsApp API account informationget
Send your WhatsApp template for approvalpost
Create a WhatsApp templatepost
Return all your created WhatsApp campaignsget
Create and Send a WhatsApp campaignpost
Return all your created WhatsApp templatesget
Update a WhatsApp campaignput
Delete a WhatsApp campaigndelete
Get a WhatsApp campaignget

Contact management
Contacts
Import contactspost
Export contactspost
Delete a contact from a listpost
Add existing contacts to a listpost
Get contacts in a listget
Get all the segmentsget
Delete a listdelete
Update a listput
Get a list's detailsget
Create a listpost
Get all the listsget
Get lists in a folderget
Delete a folder (and all its lists)delete
Update a folderput
Returns a folder's detailsget
Create a folderpost
Get all foldersget
Delete a multiple-choice attribute optiondelete
Delete an attributedelete
Create contact attributepost
Update contact attributeput
List all attributesget
Get email campaigns' statistics for a contactget
Update multiple contactspost
Update a contactput
Delete a contactdelete
Get a contact's detailsget
Create Contact via DOI (Double-Opt-In) Flowpost
Create a contactpost
Get all the contactsget

events
Event
Create an eventpost

Accounts and settings
Senders
Get all the dedicated IPs for your accountget
Get all the dedicated IPs for a senderget
Validate Sender using OTPput
Delete a senderdelete
Update a senderput
Create a new senderpost
Get the list of all your sendersget
Domains
Authenticate a domainput
Validate domain configurationget
Delete a domaindelete
Create a new domainpost
Get the list of all your domainsget
Webhooks
Export all webhook eventspost
Delete a webhookdelete
Update a webhookput
Get a webhook detailsget
Create a webhookpost
Get all webhooksget
Account
Get user activity logsget
Get your account information, plan and credits detailsget
Master account
Get the list of groupsget
Change admin user permissionsput
Check admin user permissionsget
Get the list of all admin usersget
Revoke an admin userdelete
Resend / cancel admin user invitationput
Send invitation to an admin userpost
Delete sub-account from groupput
Delete a groupdelete
Update a group of sub-accountsput
GET a group detailsget
Dissociate an IP to sub-accountsput
Associate an IP to sub-accountspost
List of all IPsget
Create a group of sub-accountspost
Enable/disable sub-account application(s)put
Create an API key for a sub-accountpost
Get the details of requested master accountget
Generate SSO token to access sub-accountpost
Generate SSO token to access admin accountpost
Update sub-accounts planput
Update sub-account planput
Delete a sub-accountdelete
Get sub-account detailsget
Create a new sub-account under a master account.post
Get the list of all the sub-accounts of the master account.get
User
Update permission for a userpost
Send invitation to userpost
Resend / Cancel invitationput
Revoke user permissionput
Check user permissionget
Get the list of all your usersget
Process
Return the informations for a processget
Return all the processes for your accountget
External Feeds
Delete an external feeddelete
Update an external feedput
Get an external feed by UUIDget
Create an external feedpost
Fetch all external feedsget

Sales CRM
Companies
Import companies(creation and updation)post
Link and Unlink company with contact and dealpatch
Get company attributesget
Create a company/deal attributepost
Update a companypatch
Delete a companydelete
Get a companyget
Create a companypost
Get all Companiesget
Deals
Import deals(creation and updation)post
Link and Unlink a deal with contacts and companiespatch
Update a dealpatch
Delete a dealdelete
Get a dealget
Create a dealpost
Get all dealsget
Get deal attributesget
Get all pipelinesget
Get a pipelineget
Get pipeline stagesget
Tasks
Update a taskpatch
Delete a taskdelete
Get a taskget
Create a taskpost
Get all tasksget
Get all task typesget
Notes
Delete a notedelete
Update a notepatch
Get a noteget
Create a notepost
Get all notesget
Files
Get file detailsget
Delete a filedelete
Download a fileget
Upload a filepost
Get all filesget

Brevo API
Conversations
Sets agent’s status to online for 2-3 minutespost
Delete an automated messagedelete
Update an automated messageput
Get an automated messageget
Send an automated message to a visitorpost
Delete a message sent by an agentdelete
Update a message sent by an agentput
Get a messageget
Send a message as an agentpost

Tracker
Restful endpoints
Track page viewspost
Track link clickspost
Track eventpost
Identify the userpost

Ecommerce
Ecommerce
Create products in batchpost
Get a product's detailsget
Create/Update a productpost
Return all your productsget
Create categories in batchpost
Get a category detailsget
Create/Update a categorypost
Return all your categoriesget
Create orders in batchpost
Managing the status of the orderpost
Get order detailsget
Get attributed product sales for a single Brevo campaign or workflowget
Get detailed attribution metrics for a single Brevo campaign or workflowget
Get attribution metrics for one or more Brevo campaigns or workflowsget
Get the ISO 4217 compliant display currency code for your Brevo accountget
Set the ISO 4217 compliant display currency code for your Brevo accountpost
Activate the eCommerce apppost
Coupons
Create coupons for a coupon collectionpost
Update a coupon collection by idpatch
Get a coupon collection by idget
Create а coupon collectionpost
Get all your coupon collectionsget
Payments
Delete a payment request.delete
Get payment request detailsget
Create a payment requestpost

Loyalty
Program
Get Subscription Dataget
Delete subscription memberdelete
Create subscription memberpost
Create subscriptionpost
Publish loyalty programpost
Delete Loyalty Programdelete
Partially update loyalty programpatch
Update loyalty programput
Get loyalty program Infoget
Create loyalty programpost
Get loyalty program listget
Reward
Validate a rewardpost
Revoke vouchersdelete
Complete redeem voucher requestpost
Create redeem voucher requestpost
Create a voucherpost
Get reward informationget
Create a rewardpost
Get Reward Page APIget
Get voucher for a contactget
Get code countget
Balance
Get Transaction History APIget
Get Active Balances APIget
Create balance orderpost
Cancel transactionpost
Complete transactionpost
Create new transactionpost
Get balance listget
Create subscription balancespost
Get subscription balancesget
Updates balance limitput
Delete balance limitdelete
Get balance limitsget
Create balance limitspost
Delete balance definitiondelete
Update balance definitionput
Get balance definitionget
Create balance definitionpost
Get balance definition listget
Tier
Assign a tierpost
Update tierput
Delete tierdelete
Create a tierpost
List tiersget
Get tier groupget
Delete tier groupdelete
Update tier groupput
List tier groupsget
Create a tier grouppost

📘

200Get WhatsApp campaign information on the basis of campaignId

400bad request

404Campaign Id not found