Skip to main content
WEBHOOK
contactOptedOut
{
  "account_id": "acct_01japd271aeatb7txrzr2xj8sg",
  "data": {
    "id": "ctc_01ja88cboqffhswjx8zbak3ykk"
  },
  "timestamp": "2024-10-21T23:29:41Z",
  "type": "contact.opted_out"
}

Documentation Index

Fetch the complete documentation index at: https://docs.surge.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
account_id
string
required

The ID of the account in which this event occurred

​
data
object
required

The data associated with the event

​
timestamp
string<date-time>
required

The timestamp when this event occurred, in ISO8601 format

​
type
string
required

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

Allowed value: "contact.opted_out"

Response

200

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