optOut
webhook event is triggered whenever a lead opts out of receiving further messages from your Apten assistant. This can be used to update your CRM or other systems about the lead’s communication preferences.
Payload
SMS Example
Email Example
Properties
Property | Type | Description |
---|---|---|
event | string | The webhook event type (optOut ). |
data.leadId | string | The unique identifier for the lead who opted out. |
data.externalLeadId | string | The CRM lead ID (Salesforce, HubSpot, or Close CRM). |
data.phone | string | The phone number of the lead who opted out. |
data.channel | string | The communication channel for the opt-out. Can be sms , email , or call . |
data.optOutReason | string | The reason for the opt-out. Only set for email opt-outs, null for SMS and calls. Can be MANUAL , COMPLAINT , BOUNCE , or UNSUBSCRIBE_LINK . |
data.isTwilioOptOut | boolean | Indicates whether the opt-out was processed through Twilio. Will be null for email opt-outs. |
data.optOutMessage | string | The message text that triggered the opt-out. Available for SMS and email opt-outs when the lead sent a message. Not included for call opt-outs or system-initiated opt-outs (bounces, complaints, unsubscribe links). |
timestamp | string | The ISO 8601 timestamp when the opt-out occurred. |