# message.held_for_approval

HTML: https://www.app2email.com/docs/api/webhooks/message.held_for_approval · Index: https://www.app2email.com/docs/api/llms.txt

A send was held by the key's approval gate.

Group: Approvals. Header `X-App2email-Event: message.held_for_approval`. 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.approval_id` | string | yes |  |
| `data.url` | string |  |  |
| `data.approve_url` | string |  |  |
| `data.recipients` | integer |  |  |
| `data.key` | string |  |  |
| `data.summary` | object |  | any keys |
| `data.expires` | string |  |  |
| `data.timestamp` | string |  |  |

## Samples

### held

```json
{
  "id": "evt_Xq3k9m2Lw8Rt5Yp1Zs01",
  "type": "message.held_for_approval",
  "created": "2026-11-06T01:00:00.000Z",
  "number": "4976659348270",
  "data": {
    "approval_id": "apr_a1b2c3d4e5f6g7h8",
    "url": "https://www.app2email.com/dashboard/approvals?id=apr_a1b2c3d4e5f6g7h8",
    "approve_url": "https://api.app2email.com/v1/4976659348270/approvals/apr_a1b2c3d4e5f6g7h8/approve",
    "recipients": 250,
    "key": "Agent key",
    "summary": {
      "type": "template",
      "template": "order_update",
      "to": 250
    },
    "expires": "2026-11-07T01:00:00.000Z",
    "timestamp": "2026-11-06T01:00:00.000Z"
  }
}
```

## Caused by

- [Send a WhatsApp message: template, or free-form reply](https://www.app2email.com/docs/api/messages/send-template-message.md): `POST /v1/{number}/messages`
- [Delete a contact record](https://www.app2email.com/docs/api/contacts/delete-contact.md): `DELETE /v1/{number}/contacts/{identity}`
- [Approve a held send: it is sent now](https://www.app2email.com/docs/api/approvals/approve-send.md): `POST /v1/{number}/approvals/{id}/approve`
- [Book an appointment for a customer at a free slot](https://www.app2email.com/docs/api/book-and-pay/create-booking.md): `POST /v1/{number}/bookings`
- [Cancel an appointment](https://www.app2email.com/docs/api/book-and-pay/cancel-booking.md): `POST /v1/{number}/bookings/{id}/cancel`

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