# client.suspended

HTML: https://www.app2email.com/docs/api/webhooks/client.suspended · Index: https://www.app2email.com/docs/api/llms.txt

A client was suspended.

Group: Partner. Header `X-App2email-Event: client.suspended`. Inside the envelope `{id, type, created, number, test?, data}` ([envelope, headers, signature](https://www.app2email.com/docs/api/webhooks.md)). Account and partner webhooks only (`/v1/account/webhooks`, `/v1/partner/webhooks`): a number's webhooks never get it.

## data

| Field | Type | Required | Notes |
| --- | --- | --- | --- |
| `data.client` | object | yes |  |
| `data.client.id` | string |  |  |
| `data.client.email` | string |  |  |
| `data.client.name` | string |  |  |
| `data.client.status` | string |  | one of: `active`, `suspended` |
| `data.client.created` | string |  |  |
| `data.client.numbers` | string[] |  |  |
| `data.client.numbers_count` | integer |  |  |
| `data.source` | string |  | partner_api, onboarding_link, register ... |
| `data.changes` | string[] |  |  |
| `data.timestamp` | string |  |  |

## Samples

### suspended

```json
{
  "id": "evt_Pt03k9m2Lw8Rt5Yp1Zs0",
  "type": "client.suspended",
  "created": "2026-11-06T09:00:00.000Z",
  "number": "",
  "data": {
    "client": {
      "id": "k3x9q2m7v8w1r4t",
      "email": "ann@example.com",
      "name": "Ann's Bakery",
      "status": "suspended",
      "created": "2026-11-05T08:00:00Z",
      "numbers": [
        "4976659348270"
      ],
      "numbers_count": 1
    },
    "changes": [
      "status"
    ],
    "timestamp": "2026-11-06T09:00:00.000Z"
  }
}
```

Test it on an account or partner webhook:

- [Send a test event to a partner webhook](https://www.app2email.com/docs/api/partner/test-partner-webhook.md): `POST /v1/partner/webhooks/{id}/test`
- [Send a test event to an account webhook](https://www.app2email.com/docs/api/account-management/test-account-webhook.md): `POST /v1/account/webhooks/{id}/test`
