Self-Exclusion: Updated

This document describes the Out-Of-The-Box (OOTB) Self-Exclusion Updated event schema. This event is triggered when the user or system updates the details of an existing self-exclusion.

Event Key

Event Key	Event Name	Type
`ootb_self_exclusion_updated`	OOTB Self-Exclusion Updated	Simple 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 Updated event.

{
  "context": {
    "ootb_self_exclusion_start_date": "2024-05-27T12:00:00Z",
    "ootb_self_exclusion_duration": "30_days",
    "ootb_self_exclusion_expiry_date": "2024-06-26T12:00:00Z",
    "ootb_exclusion_type": 0,
    "ootb_reason": "restricted player",
    "ootb_platform": "web",
    "ootb_channel": "desktop",
    "ootb_brand": "brand123",
    "ootb_license": "licenseXYZ"
  }
}

Parameters

Parameter Key	Parameter Name	Type	Description
`ootb_self_exclusion_start_date`	Self Exclusion Start Date	String	The updated date and time the self-exclusion started or will start.
`ootb_self_exclusion_duration`	Self Exclusion Duration	String	The updated duration of self-exclusion (e.g., `7_days`, `30_days`).
`ootb_self_exclusion_expiry_date`	Self Exclusion Expiry Date	String	The updated date and time when self-exclusion expires.
`ootb_exclusion_type`	Exclusion Type	Number	The updated exclusion type: `0` for self-exclusion, `1` for cool-off.
`ootb_reason`	Reason	String	The updated reason for self-exclusion (e.g., `user_requested`, `restricted_player`).
`ootb_platform`	Platform	String	Platform used for the update (e.g., `iOS`, `Android`, `Web`).
`ootb_channel`	Channel	String	Channel used for the update (e.g., `mobile`, `desktop`).
`ootb_brand`	Brand	String	The brand associated with the event.
`ootb_license`	License	String	License or regulation identifier.

Explanation

event: Set to ootb_self_exclusion_updated to signify that details of an existing self-exclusion have been changed.
context: Contains the new, updated values for the self-exclusion period.
- ootb_self_exclusion_start_date, ootb_self_exclusion_duration, ootb_self_exclusion_expiry_date: Reflect the modified timing of the self-exclusion.
- ootb_exclusion_type, ootb_reason: Show any changes to the type or reason for the exclusion.
- ootb_platform, ootb_channel, ootb_brand, ootb_license: Standard metadata.