> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ycloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# whatsapp.business_account.deleted

> Occurs when a WhatsApp Business Account is 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](https://docs.ycloud.com/en/api-reference/guides/api-fundamentals/configure-webhooks.md).

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.

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "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](https://docs.ycloud.com/en/api-reference/guides/api-fundamentals/configure-webhooks.md).

### 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](https://datatracker.ietf.org/doc/html/rfc3339). 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:<ul><li>`ACCOUNT_DISCONNECTED`: The account was disconnected due to enforcement or because the WhatsApp account was explicitly deleted.</li><li>`BUSINESS_DOWNGRADE`: The phone number was registered with the consumer WhatsApp app.</li><li>`CHANGE_NUMBER`: The WhatsApp phone number was changed.</li><li>`COMPANION_INACTIVITY`: A companion device was inactive for approximately 30 days.</li><li>`PRIMARY_INACTIVITY`: A primary device was inactive for approximately 30 days.</li><li>`USER_RE_REGISTERED`: WhatsApp was re-registered on a new device.</li></ul>Unknown values are returned as received. |
| `removedInitiatedBy` | string | No | Raw initiator from the WhatsApp Business Account deletion event. Known values include:<ul><li>`USER`: The removal was initiated by the WhatsApp user.</li><li>`SYSTEM`: The removal was initiated by the Meta system.</li></ul>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](https://datatracker.ietf.org/doc/html/rfc3339). 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.

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "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 theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```

For scenario walkthroughs, see [annotated examples](https://docs.ycloud.com/en/api-reference/guides/examples/webhook-examples/whatsapp-business-account-updated-webhook-examples).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.