Opt-Out Status Event

Coming soon

The opt-out status event is not available for webhook subscriptions yet. The payload contract is documented here so API partners can prepare their read-only integration.

The opt-out status event reports an opt-out status change for a customer's communication value, such as a phone number. It includes the previous and resulting states, the affected dealer departments, and whether an opt-in request may be sent.

The resulting optOutState is authoritative. Use oldOptOutState only to determine how the status changed.

Field Reference

payloadTop-level payload for the opt-out status event.

uuid

string

oldOptOutState

enumnullable

optOutState

enum

departmentUUIDs[]

array

communicationValue

string

timeOfChange

unix ms

commType

enum

canSendOptinRequest

boolean

{
  "id": "a7b9c1d3-e5f7-4891-ab23-cd45ef678901",
  "timestamp": 1728542293678,
  "dealeruuid": "7c1e5a9f3b7d1e5a9c3e7b1f5d9a3c7e1b5f9d3a7c1e5b9f3d7a1c5e9b3f7d1",
  "departmentuuid": "3a7f1c9e2b5d8f0a4c6e9b1d3f5a7c0e2b4d6f8a1c3e5b7d9f0a2c4e6b8d0f2",
  "type": "opt-out-status",
  "payload": {
    "uuid": "Wq7nJhXtGpBmNd3KvRzYf2kAcEiLoU8sTPeCbHwOyM1",
    "oldOptOutState": "OPTED_IN",
    "optOutState": "OPTED_OUT",
    "departmentUUIDs": [
      "3a7f1c9e2b5d8f0a4c6e9b1d3f5a7c0e2b4d6f8a1c3e5b7d9f0a2c4e6b8d0f2"
    ],
    "communicationValue": "+15551234567",
    "timeOfChange": 1788151530000,
    "commType": "TEXT",
    "canSendOptinRequest": false
  }
}

note

As with other myKaarma webhook events, the delivered payload will be a stringified JSON string. The generated example shows it as a parsed object for readability.

Integration guidance

• Treat the webhook as a read-only notification. It does not provide an API for changing opt-out status.
• Use optOutState as the final status and oldOptOutState only for change detection.
• Process each webhook event idempotently using the common envelope id.
• Apply the status independently for each UUID in departmentUUIDs.