> ## 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.updated

> Ocorre quando acontece uma violação de política, a conta do WhatsApp Business é banida e muito mais.

Use `whatsapp.business_account.updated` para processar este evento em seu endpoint de webhook.

## Gatilhos

Ocorre quando acontece uma violação de política, a conta do WhatsApp Business é banida e muito mais.

Inscreva-se em `whatsapp.business_account.updated` quando você [configurar seu endpoint de webhook](https://docs.ycloud.com/pt/api-reference/guides/api-fundamentals/configure-webhooks.md).

## Sintaxe

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

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "id": "<ID>",
  "type": "whatsapp.business_account.updated",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "whatsappBusinessAccount": {
    "id": "<ID>",
    "name": "<NAME>",
    "updateEvent": "<UPDATE_EVENT>",
    "violationType": "<VIOLATION_TYPE>",
    "restrictions": [
      {
        "restrictionType": "<RESTRICTION_TYPE>",
        "expiration": "<EXPIRATION>"
      }
    ]
  }
}
```

## Parâmetros

Valide o cabeçalho HTTP `YCloud-Signature` antes de processar o corpo JSON. Consulte a [validação de assinatura](https://docs.ycloud.com/pt/api-reference/guides/api-fundamentals/configure-webhooks.md).

### Envelope do evento

| Parâmetro | Tipo | Obrigatório | Descrição |
| - | - | - | - |
| `id` | string | Sim | ID exclusivo do evento. Tamanho mínimo: `6`. Tamanho máximo: `128`. |
| `type` | string | Sim | Sempre `whatsapp.business_account.updated`. |
| `apiVersion` | string | Sim | A versão da API usada para renderizar este evento. |
| `createTime` | string (date-time) | Sim | A data e hora em que este evento foi criado, formatada no padrão [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). Por exemplo, `2022-06-01T12:00:00.000Z`. |

### Payload do evento

| Parâmetro | Tipo | Obrigatório | Descrição |
| - | - | - | - |
| `whatsappBusinessAccount` | object | Não | Payload `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** aplica-se quando seu objeto pai estiver presente. Campos opcionais podem ser omitidos; a presença em um exemplo não torna o 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. |
| `accountReviewStatus` | string | Não | Status de análise da conta do WhatsApp Business.Valores: `PENDING`, `APPROVED`, `REJECTED`. |
| `updateEvent` | string | Não | Indica o tipo de evento de atualização da WABA quando uma notificação é enviada para você informando uma [violação de política](https://developers.facebook.com/docs/whatsapp/overview/policy-enforcement), que uma WABA foi banida e muito mais.<ul><li>`DISABLED_UPDATE`: conta do WhatsApp Business banida.</li><li>`ACCOUNT_RESTRICTION`: conta do WhatsApp Business restrita devido a violações de políticas.</li><li>`ACCOUNT_VIOLATION`: conta do WhatsApp Business violou a política.</li><li>`PARTNER_REMOVED`: a conta do WhatsApp Business foi removida da conexão de parceiro.</li><li>`PARTNER_APP_UNINSTALLED`: o aplicativo de parceiro da conta do WhatsApp Business foi desinstalado.</li><li>`AUTH_INTL_PRICE_ELIGIBILITY_UPDATE`: a conta do WhatsApp Business está qualificada para a [tarifa internacional de autenticação](https://developers.facebook.com/docs/whatsapp/pricing/authentication-international-rates).</li><li>`BUSINESS_PRIMARY_LOCATION_COUNTRY_UPDATE`: o [local de negócios principal](https://developers.facebook.com/docs/whatsapp/pricing/authentication-international-rates#primary-business-location) da empresa foi definido.</li><li>`BUSINESS_CAPABILITY_UPDATE`: a Meta informou uma alteração no Portfólio Empresarial ou no limite de registro de números de telefone da WABA.</li></ul> |
| `banState` | string | Não | O estado de banimento da conta do WhatsApp Business.Valores: `SCHEDULE_FOR_DISABLE`, `DISABLE`, `REINSTATE`. |
| `banDate` | string | Não | A data em que a WABA foi banida. |
| `violationType` | string | Não | Usado para relatar violações impostas à WABA. Consulte [Violações de aplicação de políticas](https://developers.facebook.com/documentation/business-messaging/whatsapp/policy-enforcement-violations) da Meta para tipos e descrições de violações. A Meta pode atualizar esta lista ao longo do tempo. Para tipos de violação de Utility Direct Send e detalhes de restrição, consulte o [Webhook para restrição de conta](https://developers.facebook.com/documentation/business-messaging/whatsapp/direct-send/integrity-and-content-guidelines#webhook-for-account-restriction) da Meta. |
| `restrictions` | object\[] | Não | Usado para relatar restrições impostas à WABA, quando essa WABA viola as [políticas da Plataforma do WhatsApp Business](https://developers.facebook.com/docs/whatsapp/overview/policy-enforcement). |
| `maxPhoneNumbersPerBusiness` | integer (int32) | Não | Incluído em um webhook `whatsapp.business_account.updated` com `updateEvent=BUSINESS_CAPABILITY_UPDATE` quando a Meta relata o limite de registro de números de telefone do portfólio empresarial. A Meta atualmente relata este campo separadamente de `maxPhoneNumbersPerWaba`, mas os consumidores devem processar ambos se uma atualização futura os incluir juntos. |
| `maxPhoneNumbersPerWaba` | integer (int32) | Não | Incluído em um webhook `whatsapp.business_account.updated` com `updateEvent=BUSINESS_CAPABILITY_UPDATE` quando a Meta relata o limite de registro de números de telefone da WABA. A Meta atualmente relata este campo separadamente de `maxPhoneNumbersPerBusiness`, mas os consumidores devem processar ambos se uma atualização futura os incluir juntos. |
| `authIntlRateEligibilityCountries` | object\[] | Não | A partir de 1º de junho de 2024, estamos atualizando nossa tabela de tarifas de autenticação e introduzindo uma nova tarifa de autenticação internacional. Esta tarifa se aplicará nos seguintes países:<ul><li>1º de junho de 2024 – Indonésia (código de chamada do país +62, código do país `ID`)</li><li>1º de julho de 2024 – Índia (código de chamada do país +91, código do país `IN`)</li></ul>Consulte também [Tarifas de Autenticação Internacional](https://developers.facebook.com/docs/whatsapp/pricing/authentication-international-rates). |
| `primaryBusinessLocation` | string | Não | A localização principal da sua empresa é o país onde ela está sediada. Ela aparecerá no Gerenciador de Negócios no campo Localização principal da empresa a partir de 1º de maio de 2024. [Código de país ISO 3166-1 alfa-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). |

> [accordion] whatsappBusinessAccount.restrictions\[]
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `restrictionType` | string | Não | Tipo de restrição.Valores: `RESTRICTED_ADD_PHONE_NUMBER_ACTION`, `RESTRICTED_BIZ_INITIATED_MESSAGING`, `RESTRICTED_CUSTOMER_INITIATED_MESSAGING`, `RESTRICTED_DIRECT_SEND_UTILITY_TEMPLATES`. |
> | `expiration` | string (date-time) | Não | O horário em que esta restrição expira, formatado em [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). Ex.: `2022-06-01T12:00:00.000Z`. |

> [accordion] whatsappBusinessAccount.authIntlRateEligibilityCountries\[]
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `countryCode` | string | Não | [Código de país ISO 3166-1 alfa-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). |
> | `startTime` | string (date-time) | Não | Data em que as conversas de autenticação recém-iniciadas passam a estar sujeitas às tarifas de autenticação internacional, formatada em [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). Ex.: `2024-07-01T00: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.

> [accordion] Evento de restrição de Utility Direct Send
>
> A Meta restringiu o Utility Direct Send por 7 dias após o uso indevido repetido da categoria.
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_direct_send_restriction_123",
>   "type": "whatsapp.business_account.updated",
>   "apiVersion": "v2",
>   "createTime": "2026-09-17T08:00:00.000Z",
>   "whatsappBusinessAccount": {
>     "id": "whatsapp-business-account-id",
>     "name": "Example business",
>     "updateEvent": "ACCOUNT_RESTRICTION",
>     "violationType": "DIRECT_SEND_UTILITY_CATEGORY_ABUSE_STRIKE_1",
>     "restrictions": [
>       {
>         "restrictionType": "RESTRICTED_DIRECT_SEND_UTILITY_TEMPLATES",
>         "expiration": "2026-09-24T08:00:00.000Z"
>       }
>     ]
>   }
> }
> ```

> [accordion] Elegibilidade para tarifa de autenticação internacional
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_djeIQXaQPQyUcRFi",
>   "type": "whatsapp.business_account.updated",
>   "apiVersion": "v2",
>   "createTime": "2024-06-01T00:00:00.000Z",
>   "whatsappBusinessAccount": {
>     "id": "106681...",
>     "updateEvent": "AUTH_INTL_PRICE_ELIGIBILITY_UPDATE",
>     "authIntlRateEligibilityCountries": [
>       {
>         "countryCode": "IN",
>         "startTime": "2024-07-01T00:00:00.000Z"
>       },
>       {
>         "countryCode": "ID",
>         "startTime": "2024-07-01T00:00:00.000Z"
>       }
>     ]
>   }
> }
> ```

> [accordion] Atualização da localização principal da empresa
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_djeIQXaQPQyUcRFi",
>   "type": "whatsapp.business_account.updated",
>   "apiVersion": "v2",
>   "createTime": "2024-06-01T00:00:00.000Z",
>   "whatsappBusinessAccount": {
>     "id": "106681...",
>     "updateEvent": "BUSINESS_PRIMARY_LOCATION_COUNTRY_UPDATE",
>     "primaryBusinessLocation": "US"
>   }
> }
> ```

> [accordion] Atualização do limite de registro de números de telefone
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_djeIQXaQPQyUcRFi",
>   "type": "whatsapp.business_account.updated",
>   "apiVersion": "v2",
>   "createTime": "2026-09-23T00:00:00.000Z",
>   "whatsappBusinessAccount": {
>     "id": "106681...",
>     "updateEvent": "BUSINESS_CAPABILITY_UPDATE",
>     "maxPhoneNumbersPerWaba": 25
>   }
> }
> ```

> [accordion] Violação de conta
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_djeIQXaQPQyUcRFi",
>   "type": "whatsapp.business_account.updated",
>   "apiVersion": "v2",
>   "createTime": "2024-06-01T00:00:00.000Z",
>   "whatsappBusinessAccount": {
>     "id": "106681...",
>     "updateEvent": "ACCOUNT_VIOLATION",
>     "violationType": "SCAM"
>   }
> }
> ```

> [accordion] Restrição de conta
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_djeIQXaQPQyUcRFi",
>   "type": "whatsapp.business_account.updated",
>   "apiVersion": "v2",
>   "createTime": "2024-06-01T00:00:00.000Z",
>   "whatsappBusinessAccount": {
>     "id": "106681...",
>     "updateEvent": "ACCOUNT_RESTRICTION",
>     "restrictions": [
>       {
>         "restrictionType": "RESTRICTED_ADD_PHONE_NUMBER_ACTION",
>         "expiration": "2024-09-01T12:00:00.000Z"
>       },
>       {
>         "restrictionType": "RESTRICTED_BIZ_INITIATED_MESSAGING",
>         "expiration": "2024-09-01T12:00:00.000Z"
>       },
>       {
>         "restrictionType": "RESTRICTED_CUSTOMER_INITIATED_MESSAGING",
>         "expiration": "2024-09-01T12:00:00.000Z"
>       }
>     ]
>   }
> }
> ```

> [accordion] Conta desativada
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_djeIQXaQPQyUcRFi",
>   "type": "whatsapp.business_account.updated",
>   "apiVersion": "v2",
>   "createTime": "2024-06-01T00:00:00.000Z",
>   "whatsappBusinessAccount": {
>     "id": "106681...",
>     "updateEvent": "DISABLED_UPDATE",
>     "banDate": "September 19, 2024",
>     "banState": "DISABLE"
>   }
> }
> ```

> [accordion] Restauração de conta
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_djeIQXaQPQyUcRFi",
>   "type": "whatsapp.business_account.updated",
>   "apiVersion": "v2",
>   "createTime": "2024-06-01T00:00:00.000Z",
>   "whatsappBusinessAccount": {
>     "id": "106681...",
>     "updateEvent": "DISABLED_UPDATE",
>     "banState": "REINSTATE",
>     "banDate": "December 27, 2024",
>     "accountReviewStatus": "APPROVED"
>   }
> }
> ```

Após verificar a assinatura e aceitar o evento de forma duradoura, retorne uma resposta `2xx`. Processe tarefas demoradas de forma assíncrona.

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```

Para orientações detalhadas de cenários, consulte os [exemplos anotados](https://docs.ycloud.com/pt/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.