Skip to main content
The doNotContact webhook event fires when a lead makes a clear, explicit request to stop all contact across every channel. Unlike a per-channel opt-out, this signals that the lead has expressed they do not want to be reached by any medium. This event is triggered only when Apten’s AI determines the lead’s intent is to completely end all communication — not from automated opt-outs, bounces, or single-channel unsubscribes. When a do-not-contact request is detected, Apten fires this event first, then fires an optOut event for each channel the lead is enrolled in. Those optOut events will include "isDoNotContact": true in their payloads.

​
Payload

​
SMS Example

{
  "event": "doNotContact",
  "data": {
    "leadId": "a7e92c5d-f301-4b89-ae16-8f35d02cx9z",
    "externalLeadId": "003XX000004DHPY",
    "phone": "+13305551234",
    "email": null,
    "optOutMessage": "Do not contact me ever again."
  },
  "timestamp": "2024-02-18T09:45:22Z"
}

​
Call Example

{
  "event": "doNotContact",
  "data": {
    "leadId": "a7e92c5d-f301-4b89-ae16-8f35d02cx9z",
    "externalLeadId": "003XX000004DHPY",
    "phone": "+13305551234",
    "email": null,
    "optOutMessage": null
  },
  "timestamp": "2024-02-18T09:45:22Z"
}

​
Properties

PropertyTypeDescription
eventstringThe webhook event type (doNotContact).
data.leadIdstringThe unique identifier for the lead.
data.externalLeadIdstringThe CRM lead ID (Salesforce, HubSpot, or Dynamics 365).
data.phonestringThe phone number of the lead.
data.emailstringThe email address of the lead, if available.
data.optOutMessagestringThe message text that surfaced the do-not-contact request. Available for SMS and email; null for call interactions.
timestampstringThe ISO 8601 timestamp when the do-not-contact status was set.