contact.unsubscribe.created

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

Triggers

Occurs when a contact unsubscribes from messages. Subscribe to contact.unsubscribe.created when you configure your webhook endpoint.

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.

{
  "id": "<ID>",
  "type": "contact.unsubscribe.created",
  "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.

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.created`.
`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. 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.

Customer cancels subscription event

Example payload when a customer cancels subscription

{
  "id": "evt_3456789012",
  "type": "contact.unsubscribe.created",
  "apiVersion": "v2",
  "createTime": "2024-01-01T12:00:00.000Z",
  "unsubscriberChanged": {
    "phoneNumber": "+12025550124",
    "source": "Whatsapp",
    "updateTime": "2024-01-01T12:00:00.000Z"
  }
}

Contact Unsubscribe Created Example

{
  "id": "evt_68f8886903683f3481f9707b",
  "type": "contact.unsubscribe.created",
  "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/1.1 200 OK

For scenario walkthroughs, see annotated examples.

Getting Started

Guides

Endpoints

Webhook reference

contact.unsubscribe.created

Triggers

Syntax

Parameters

Event envelope

Event payload

unsubscriberChanged

Example

​Triggers

​Syntax

​Parameters

​Event envelope

​Event payload

​unsubscriberChanged

​Example

Triggers

Syntax

Parameters

Event envelope

Event payload

unsubscriberChanged

Example