Sign in

v53

latestOpenAPI 3.1.1raw.githubusercontent.com2026-07-264065213.4 KB

The contact.opted_out event is delivered whenever a contact opts out of receiving messages by sending a keyword message (STOP, CANCEL, UNSUBSCRIBE, etc.).

postWebhookcontactOptedOut

Payload

account_idstring required

The ID of the account in which this event occurred

timestampstring date-time required

The timestamp when this event occurred, in ISO8601 format

type'contact.opted_out' required

The type of the event. Always contact.opted_out for this event.

Example payload

{
  "account_id": "acct_01japd271aeatb7txrzr2xj8sg",
  "data": {
    "id": "ctc_01ja88cboqffhswjx8zbak3ykk"
  },
  "timestamp": "2024-10-21T23:29:41Z",
  "type": "contact.opted_out"
}

Response

Return a 200 status to indicate that the data was received successfully