whatsapp.business_account.deleted

Use whatsapp.business_account.deleted para processar este evento no endpoint do seu webhook.

Gatilhos

Ocorre quando uma conta do WhatsApp Business é excluída. Inscreva-se em whatsapp.business_account.deleted quando você configurar o endpoint do seu webhook. Use whatsappBusinessAccount.id para identificar a conta removida. Os campos de remoção são opcionais. Preserve valores desconhecidos de removedReason e removedInitiatedBy. O campo removedTime registra quando o evento de exclusão foi recebido, e não a hora exata da exclusão.

Sintaxe

A YCloud envia uma solicitação HTTP POST para a URL do seu webhook configurado. O formato a seguir mostra uma variante de payload. Os valores entre colchetes angulares são marcadores; seus tipos estão listados em Parâmetros. Campos opcionais e outras variantes são descritos abaixo.

{
  "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>"
  }
}

Parâmetros

Valide o cabeçalho HTTP YCloud-Signature antes de processar o corpo JSON. Consulte validação de assinatura.

Envelope do evento

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID exclusivo para o evento. Comprimento mínimo: `6`. Comprimento máximo: `128`.
`type`	string	Sim	Sempre `whatsapp.business_account.deleted`.
`apiVersion`	string	Sim	A versão da API usada para renderizar este evento.
`createTime`	string (date-time)	Sim	O momento em que este evento foi criado, formatado em RFC 3339. Ex.: `2022-06-01T12:00:00.000Z`.

Payload do evento

Parâmetro	Tipo	Obrigatório	Descrição
`whatsappBusinessAccount`	object	Não	Payload do `whatsappBusinessAccount` específico do evento.

Os quatro campos comuns do envelope são obrigatórios. Os campos do payload dependem da variante do evento. Em cada tabela de objeto, Obrigatório se aplica quando o objeto pai estiver presente. Campos opcionais podem ser omitidos; um exemplo não torna um campo obrigatório.

whatsappBusinessAccount

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	ID da conta do WhatsApp Business.
`name`	string	Não	Nome amigável para diferenciar as contas do WhatsApp Business.
`removedReason`	string	Não	Motivo bruto do evento de exclusão da conta do WhatsApp Business. Os valores conhecidos incluem: `ACCOUNT_DISCONNECTED`: a conta foi desconectada por aplicação de políticas ou porque a conta do WhatsApp foi explicitamente excluída. `BUSINESS_DOWNGRADE`: o número de telefone foi registrado no aplicativo de consumidor do WhatsApp. `CHANGE_NUMBER`: o número de telefone do WhatsApp foi alterado. `COMPANION_INACTIVITY`: um dispositivo complementar ficou inativo por aproximadamente 30 dias. `PRIMARY_INACTIVITY`: um dispositivo principal ficou inativo por aproximadamente 30 dias. `USER_RE_REGISTERED`: o WhatsApp foi registrado novamente em um novo dispositivo. Valores desconhecidos são retornados conforme recebidos.
`removedInitiatedBy`	string	Não	Iniciador bruto do evento de exclusão da conta do WhatsApp Business. Os valores conhecidos incluem: `USER`: a remoção foi iniciada pelo usuário do WhatsApp. `SYSTEM`: a remoção foi iniciada pelo sistema da Meta. Valores desconhecidos são retornados conforme recebidos.
`removedTime`	string (date-time)	Não	O momento em que o evento de exclusão da conta do WhatsApp Business foi recebido, formatado em RFC 3339. Ex.: `2026-05-19T12:00:00.000Z`.

Exemplo

O JSON a seguir é o corpo entregue ao seu receptor. IDs, números de telefone e outros valores de conta são ilustrativos. Leia whatsappBusinessAccount.id para identificar a conta. Quando presentes, removedReason, removedInitiatedBy e removedTime descrevem a remoção. Preserve valores desconhecidos de motivo e iniciador.

{
  "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"
  }
}

Depois de verificar a assinatura e aceitar o evento de forma duradoura, retorne uma resposta 2xx. Processe tarefas lentas de forma assíncrona.

HTTP/1.1 200 OK

Para orientações sobre os cenários, consulte os exemplos anotados.

Primeiros passos

Guias

Endpoints

Webhook reference

whatsapp.business_account.deleted

Gatilhos

Sintaxe

Parâmetros

Envelope do evento

Payload do evento

whatsappBusinessAccount

Exemplo

​Gatilhos

​Sintaxe

​Parâmetros

​Envelope do evento

​Payload do evento

​whatsappBusinessAccount

​Exemplo

Gatilhos

Sintaxe

Parâmetros

Envelope do evento

Payload do evento

whatsappBusinessAccount

Exemplo