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

# contact.unsubscribe.deleted

> Occurs when a contact resumes subscription to messages.

Use `contact.unsubscribe.deleted` to handle this event at your webhook endpoint.

## Triggers

Occurs when a contact resumes subscription to messages.

Subscribe to `contact.unsubscribe.deleted` when you [configure your webhook endpoint](https://docs.ycloud.com/en/api-reference/guides/api-fundamentals/configure-webhooks.md).

## Syntax

YCloud sends an HTTP `POST` request to your configured webhook URL. The following shape shows one payload variant. Angle-bracket values are placeholders; their types are listed under **Parameters**. Optional fields and other variants are described below.

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "id": "<ID>",
  "type": "contact.unsubscribe.deleted",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "unsubscriberChanged": {
    "phoneNumber": "<PHONE_NUMBER>",
    "source": "<SOURCE>",
    "updateTime": "<UPDATE_TIME>"
  }
}
```

## Parameters

Validate the `YCloud-Signature` HTTP header before you process the JSON body. See [signature validation](https://docs.ycloud.com/en/api-reference/guides/api-fundamentals/configure-webhooks.md).

### Event envelope

| Parameter | Type | Required | Description |
| - | - | - | - |
| `id` | string | Yes | Unique ID for the event. Minimum length: `6`. Maximum length: `128`. |
| `type` | string | Yes | Always `contact.unsubscribe.deleted`. |
| `apiVersion` | string | Yes | The API version used to render this event. |
| `createTime` | string (date-time) | Yes | The time at which this event was created, formatted in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). e.g., `2022-06-01T12:00:00.000Z`. |

### Event payload

| Parameter | Type | Required | Description |
| - | - | - | - |
| `unsubscriberChanged` | object | No | Event-specific `unsubscriberChanged` payload. |

The four common envelope fields are required. Payload fields depend on the event variant. In each object table, **Required** applies when its parent object is present. Optional fields can be omitted; a sample does not make a field required.

#### unsubscriberChanged

| Parameter | Type | Required | Description |
| - | - | - | - |
| `id` | string | No | Identifier supplied with the subscription change, when available. |
| `phoneNumber` | string | No | Customer phone number in E.164 format. |
| `source` | string | No | Source of the subscription change. Known values include `Whatsapp`, `Inbox`, `Chatbot`, `API`, `Manual`, and `Unknown`. Preserve unrecognized values. |
| `updateTime` | string (date-time) | No | Time of the subscription change, formatted in RFC 3339. |

## Example

The following JSON is the body delivered to your receiver. IDs, phone numbers, and other account values are illustrative.

> [accordion] Customer resumes subscription
>
> Example payload when a customer resumes subscription
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_3456789012",
>   "type": "contact.unsubscribe.deleted",
>   "apiVersion": "v2",
>   "createTime": "2024-01-01T12:00:00.000Z",
>   "unsubscriberChanged": {
>     "phoneNumber": "+12025550124",
>     "source": "Whatsapp",
>     "updateTime": "2024-01-01T12:00:00.000Z"
>   }
> }
> ```

> [accordion] Contact Unsubscribe deleted Example
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_68f8886903683f3481f9707b",
>   "type": "contact.unsubscribe.deleted",
>   "apiVersion": "v2",
>   "createTime": "2025-10-22T07:31:53.872Z",
>   "unsubscriberChanged": {
>     "id": "68f888692abba5779b565928",
>     "phoneNumber": "+12025550124",
>     "source": "API",
>     "updateTime": "2025-10-22T07:31:53.864Z"
>   }
> }
> ```

After verifying the signature and durably accepting the event, return a `2xx` response. Process slow work asynchronously.

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

For scenario walkthroughs, see [annotated examples](https://docs.ycloud.com/en/api-reference/guides/examples/webhook-examples/contact-unsubscribe-deleted-webhook-examples).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.