Release a WhatsApp number

Detach the number from your org. Inbound WhatsApp calls to it are rejected from then on; nothing changes on Meta's side. Requires the telephony:manage scope.

delete/v1/whatsapp/numbers/{id}

Request

Base URL: https://api.pyai.com
URL: https://api.pyai.com/v1/whatsapp/numbers/{id}
Auth: one of:
- HTTP bearer
- API key in header x-api-key

Path parameters

idstring required

Response

Released

objectstring

idstring

waba_idstring

WhatsApp Business Account id.

phone_number_idstring

Meta's id for the business number (what the webhook carries).

phone_numberstring

E.164.

app_idstring nullable

agent_idstring nullable

Agent that answers inbound WhatsApp calls.

calling_enabledboolean

calling_settingsobject

Last calling settings pushed to Meta.

status'active' | 'released'

created_atinteger

Unix ms.

updated_atinteger

Unix ms.

released_atinteger nullable

Unix ms.

Example response

{
  "object": "whatsapp.number",
  "id": "wan_...",
  "phone_number": "+14155550123"
}

Changes

No recorded changes to this operation across all 1 revision of this API.