Communication Preferences

Events that occur when a contact's communication preference (opt-in status) is updated or a contact opts out of a channel.

communication_preference.updated

{
  "data":{
    "id":"c4d8b2a1-7f3e-4a6b-9c2d-1e5f8a9b0c3d",
    "opt_in":true,
    "opt_in_date":"2023-09-08T13:55:10.584156Z",
    "opt_out_date":null,
    "last_campaign_date":"2023-09-07T09:12:44.000000Z",
    "channel_id":"029f876c-e60f-454b-8e51-4c38f0484140",
    "contact_id":"db737fac-9b54-48ba-9fdc-7db30f907fab",
    "paused_until":null,
    "created_at":"2023-09-08T13:55:10.584156Z",
    "updated_at":"2023-09-08T13:55:10.584156Z"
  },
  "event":"communication_preference.updated",
  "request_id":"13d0abf8-e54e-4bf0-a645-f7ff68c703a4"
}

communication_preference.opt_out

{
  "data":{
    "id":"c4d8b2a1-7f3e-4a6b-9c2d-1e5f8a9b0c3d",
    "opt_in":false,
    "opt_in_date":"2023-09-08T13:55:10.584156Z",
    "opt_out_date":"2023-09-09T16:20:33.129847Z",
    "last_campaign_date":"2023-09-07T09:12:44.000000Z",
    "channel_id":"029f876c-e60f-454b-8e51-4c38f0484140",
    "contact_id":"db737fac-9b54-48ba-9fdc-7db30f907fab",
    "paused_until":null,
    "created_at":"2023-09-08T13:55:10.584156Z",
    "updated_at":"2023-09-09T16:20:33.129847Z"
  },
  "event":"communication_preference.opt_out",
  "request_id":"13d0abf8-e54e-4bf0-a645-f7ff68c703a4"
}


Did this page help you?