Self-Exclusion: Initiated

This document describes the Out-Of-The-Box (OOTB) Self-Exclusion Initiated event schema. This event is triggered when the user initiates the self-exclusion process, either voluntarily or as recommended by a responsible party.

Event Key

Event Key	Event Name	Type
`ootb_self_exclusion_initiated`	OOTB Self-Exclusion Initiated	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 Initiated event.

Parameters

Parameter Key	Parameter Name	Type	Description
`ootb_self_exclusion_start_date`	Self Exclusion Start Date	String	The date and time the self-exclusion was started.
`ootb_self_exclusion_duration`	Self Exclusion Duration	String	Duration of self-exclusion (e.g., `7_days`, `30_days`).
`ootb_self_exclusion_expiry_date`	Self Exclusion Expiry Date	String	The date and time when self-exclusion expires.
`ootb_exclusion_type`	Exclusion Type	Number	The exclusion type: `0` for self-exclusion, `1` for cool-off.
`ootb_reason`	Reason	String	Reason for self-exclusion (e.g., `user_requested`, `restricted_player`).
`ootb_platform`	Platform	String	Platform used (e.g., `iOS`, `Android`, `Web`).
`ootb_channel`	Channel	String	Channel used (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_initiated to signify that a user has started the self-exclusion process.
context:
- ootb_self_exclusion_start_date: Records when the self-exclusion period is intended to begin.
- ootb_self_exclusion_duration: Specifies the length of the requested self-exclusion period.
- ootb_self_exclusion_expiry_date: The calculated date and time when the self-exclusion will end.
- ootb_exclusion_type: Differentiates between a full self-exclusion and a cool-off period.
- ootb_reason: Provides context for why the self-exclusion was initiated.
- ootb_platform, ootb_channel, ootb_brand, ootb_license: Standard metadata about the user's environment and relevant identifiers.