Get your WhatsApp API account information

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.

Response

Get all the information of your WhatsApp API account

businessStatusstring or null

Verification status information of the Business account

phoneNumberNameStatusenum or null

Status of the name associated with WhatsApp Phone number

Allowed values:

phoneNumberQualityenum or null

Quality status of phone number associated with WhatsApp account. There are three quality ratings. example - High (GREEN) , Medium (YELLOW) and Low(RED)

Allowed values:

sendingLimitstring or null

Sending limit of the WhatsApp account

whatsappBusinessAccountIdstring or null

Id of the WhatsApp business account

whatsappBusinessAccountStatusenum or null

Status information related to WhatsApp Api account

Allowed values:

1	{
2	"businessStatus": "verified",
3	"phoneNumberNameStatus": "APPROVED",
4	"phoneNumberQuality": "GREEN",
5	"sendingLimit": "TIER_1K",
6	"whatsappBusinessAccountStatus": "APPROVED",
7	"whatsappBusinessAccountID": 105569359072383
8	}

Authentication

Response

Errors