WhatsApp

Retrieve a WhatsApp Business Account

Changed on

Returns the WhatsApp Business Account linked to your account with the given ID, including its messaging limit and number of senders.

Behavior: Returns 404 when the WhatsApp Business Account isn't linked to your account.

Requires: Your account must have WhatsApp enabled, must have a subscription plan, and must not be blocked or suspended.

get/v1/whatsapp/wabas/{waba_id}

Request

  • Base URL
    https://api.wavix.com
  • URL
    https://api.wavix.com/v1/whatsapp/wabas/{waba_id}
  • Auth
    HTTP bearer

Path parameters

waba_idstring required

ID of a WhatsApp Business Account linked to your account, as returned in id by whatsapp_wabas_list or in waba.id on senders and templates.

Response

The requested WhatsApp Business Account.

idstring required

ID of the WhatsApp Business Account, as returned in waba.id on senders and templates.

namestring nullable required

Name of the WhatsApp Business Account.

messaging_limit'up_to_250' | 'up_to_2k' | 'up_to_10k' | 'up_to_100k' | 'unlimited'

Maximum number of unique customers the WhatsApp Business Account can start conversations with in a rolling 24-hour period. Omitted when the limit isn't known yet. Possible values:

  • up_to_250 — Up to 250 unique customers.
  • up_to_2k — Up to 2,000 unique customers.
  • up_to_10k — Up to 10,000 unique customers.
  • up_to_100k — Up to 100,000 unique customers.
  • unlimited — No limit on unique customers.
sender_countinteger required

Number of senders registered in the WhatsApp Business Account.

Example response

{
  "id": "102290129340398",
  "name": "Acme Support",
  "messaging_limit": "up_to_2k",
  "sender_count": 2
}

Changes