contact.opted_out
A contact opted out of messages.
Fires when the customer sends an opt-out keyword, stops broadcasts, or a team member marks them opted out.
Does not fire when they are already opted out. Opting back in is contact.updated with optedOut: false.
Header Parameters
t=<unix seconds>,v1=<hex HMAC-SHA256 of "{t}.{body}">, with a second v1 while a rotated secret still signs. Verify it before trusting the body.
The event's type, so a receiver can route before parsing.
This delivery's id. A resend of the same event keeps the envelope id and gets a new delivery id.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Every event arrives in this envelope. Fields are only ever added, and a field that can be empty is sent as null rather than left out. Deduplicate on id: a delivery can arrive more than once.
Response Body
Example Requests
/contact.opted_out