whatsapp.business_account.deleted

Use whatsapp.business_account.deleted to handle this event at your webhook endpoint.

Triggers

Occurs when a WhatsApp Business Account is deleted. Subscribe to whatsapp.business_account.deleted when you configure your webhook endpoint. Use whatsappBusinessAccount.id to identify the removed account. The removal fields are optional. Preserve unknown removedReason and removedInitiatedBy values. removedTime records when the deletion event was received, not the exact deletion time.

Syntax

YCloud sends an HTTP POST request to your configured webhook URL. The following shape shows one payload variant. Angle-bracket values are placeholders; their types are listed under Parameters. Optional fields and other variants are described below.

{
  "id": "<ID>",
  "type": "whatsapp.business_account.deleted",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "whatsappBusinessAccount": {
    "id": "<ID>",
    "name": "<NAME>",
    "removedReason": "<REMOVED_REASON>",
    "removedInitiatedBy": "<REMOVED_INITIATED_BY>",
    "removedTime": "<REMOVED_TIME>"
  }
}

Parameters

Validate the YCloud-Signature HTTP header before you process the JSON body. See signature validation.

Event envelope

Parameter	Type	Required	Description
`id`	string	Yes	Unique ID for the event. Minimum length: `6`. Maximum length: `128`.
`type`	string	Yes	Always `whatsapp.business_account.deleted`.
`apiVersion`	string	Yes	The API version used to render this event.
`createTime`	string (date-time)	Yes	The time at which this event was created, formatted in RFC 3339. e.g., `2022-06-01T12:00:00.000Z`.

Event payload

Parameter	Type	Required	Description
`whatsappBusinessAccount`	object	No	Event-specific `whatsappBusinessAccount` payload.

The four common envelope fields are required. Payload fields depend on the event variant. In each object table, Required applies when its parent object is present. Optional fields can be omitted; a sample does not make a field required.

whatsappBusinessAccount

Parameter	Type	Required	Description
`id`	string	No	WhatApp Business Account ID.
`name`	string	No	User-friendly name to differentiate WhatsApp Business Accounts.
`removedReason`	string	No	Raw reason from the WhatsApp Business Account deletion event. Known values include: `ACCOUNT_DISCONNECTED`: The account was disconnected due to enforcement or because the WhatsApp account was explicitly deleted. `BUSINESS_DOWNGRADE`: The phone number was registered with the consumer WhatsApp app. `CHANGE_NUMBER`: The WhatsApp phone number was changed. `COMPANION_INACTIVITY`: A companion device was inactive for approximately 30 days. `PRIMARY_INACTIVITY`: A primary device was inactive for approximately 30 days. `USER_RE_REGISTERED`: WhatsApp was re-registered on a new device. Unknown values are returned as received.
`removedInitiatedBy`	string	No	Raw initiator from the WhatsApp Business Account deletion event. Known values include: `USER`: The removal was initiated by the WhatsApp user. `SYSTEM`: The removal was initiated by the Meta system. Unknown values are returned as received.
`removedTime`	string (date-time)	No	The time when the WhatsApp Business Account deletion event was received, formatted in RFC 3339. e.g., `2026-05-19T12:00:00.000Z`.

Example

The following JSON is the body delivered to your receiver. IDs, phone numbers, and other account values are illustrative. Read whatsappBusinessAccount.id to identify the account. When present, removedReason, removedInitiatedBy, and removedTime describe the removal. Preserve unknown reason and initiator values.

{
  "id": "evt_business_account_deleted_123",
  "type": "whatsapp.business_account.deleted",
  "apiVersion": "v2",
  "createTime": "2026-05-26T12:00:00.000Z",
  "whatsappBusinessAccount": {
    "id": "whatsapp-business-account-id",
    "name": "Example business",
    "removedReason": "ACCOUNT_DISCONNECTED",
    "removedInitiatedBy": "USER",
    "removedTime": "2026-05-26T12:00:00.000Z"
  }
}

After verifying the signature and durably accepting the event, return a 2xx response. Process slow work asynchronously.

HTTP/1.1 200 OK

For scenario walkthroughs, see annotated examples.

Getting Started

Guides

Endpoints

Webhook reference

whatsapp.business_account.deleted

Triggers

Syntax

Parameters

Event envelope

Event payload

whatsappBusinessAccount

Example

​Triggers

​Syntax

​Parameters

​Event envelope

​Event payload

​whatsappBusinessAccount

​Example

Triggers

Syntax

Parameters

Event envelope

Event payload

whatsappBusinessAccount

Example