Skip to main content
WEBHOOK
Fires when a contact sends an opt-out keyword (STOP, CANCEL, UNSUBSCRIBE, END, QUIT) to one of your phone numbers. Surge automatically stops message delivery to opted-out contacts. You should also suppress future sends to this contact in your own system.

​
Common use case

Use contact.opted_out to suppress the contact in your own marketing or CRM system. Any attempt to send to an opted-out contact via the Surge API will return an opted_out error.

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