# contact.opted_out

HTML: https://www.app2email.com/docs/api/webhooks/contact.opted_out · Index: https://www.app2email.com/docs/api/llms.txt

A contact was added to the Do Not Call list by their own action.

Group: Contacts. Header `X-App2email-Event: contact.opted_out`. Inside the envelope `{id, type, created, number, test?, data}` ([envelope, headers, signature](https://www.app2email.com/docs/api/webhooks.md)). Every webhook of the number gets every number event: filter by `type`.

## data

| Field | Type | Required | Notes |
| --- | --- | --- | --- |
| `data.number` | string | yes |  |
| `data.name` | string |  |  |
| `data.source` | string | yes | one of: `stop_promotions`, `whatsapp_stop`, `keyword` |
| `data.detail` | string |  |  |
| `data.timestamp` | string |  |  |

## Samples

### stop promotions

```json
{
  "id": "evt_Xq3k9m2Lw8Rt5Yp1Zs01",
  "type": "contact.opted_out",
  "created": "2026-11-06T01:00:00.000Z",
  "number": "4976659348270",
  "data": {
    "number": "61412345678",
    "name": "Sample Contact",
    "source": "stop_promotions",
    "detail": "Stop promotions",
    "timestamp": "2026-11-06T01:00:00.000Z"
  }
}
```

Send it to your URL: https://www.app2email.com/docs/api/webhooks/tester?type=contact.opted_out
