Self-Exclusion: Lifted

This document describes the Out-Of-The-Box (OOTB) Self-Exclusion Lifted event schema. This event is triggered when the self-exclusion period ends, and the user's account is typically reinstated or eligible for reinstatement.

Event Key

Event KeyEvent NameType
ootb_self_exclusion_liftedOOTB Self-Exclusion LiftedSimple event

Event Structure

The mandatory properties (tenant, timestamp, event, and customer) are required for all events and documented in detail on the Mandatory Properties page.

Below is the JSON structure for the context-specific properties of the OOTB Self-Exclusion Lifted event.

{
  "context": {
    "ootb_self_exclusion_end_date": "2024-06-26T12:00:00Z",
    "ootb_platform": "web",
    "ootb_channel": "desktop",
    "ootb_brand": "brand123",
    "ootb_license": "licenseXYZ"
  }
}

Parameters

Parameter KeyParameter NameTypeDescription
ootb_self_exclusion_end_dateSelf Exclusion End DateStringThe date and time the self-exclusion ends or ended.
ootb_platformPlatformStringPlatform where the lifting is recorded (e.g., iOS, Android, Web).
ootb_channelChannelStringChannel through which this is noted (e.g., mobile, desktop, system).
ootb_brandBrandStringThe brand associated with the event.
ootb_licenseLicenseStringLicense or regulation identifier.

Explanation

  • event: Set to ootb_self_exclusion_lifted to indicate that a self-exclusion period has concluded.
  • context:
    • ootb_self_exclusion_end_date: Specifies when the self-exclusion officially ended.
    • ootb_platform, ootb_channel, ootb_brand, ootb_license: Standard metadata.