Self-Exclusion: Activated

This document describes the Out-Of-The-Box (OOTB) Self-Exclusion Activated event schema. This event confirms that the self-exclusion has been successfully activated in the system.

Event Key

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

{
  "context": {
    "ootb_self_exclusion_start_date": "2024-05-27T12:00:00Z",
    "ootb_self_exclusion_expiry_date": "2024-06-26T12:00:00Z",
    "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 date and time the self-exclusion started.
`ootb_self_exclusion_expiry_date`	Self Exclusion Expiry Date	String	The date and time the self-exclusion expires.
`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_activated to signify that the self-exclusion period is now active.
context:
- ootb_self_exclusion_start_date: Confirms the exact start date and time of the active self-exclusion.
- ootb_self_exclusion_expiry_date: Confirms the exact end date and time of the active self-exclusion.
- ootb_platform, ootb_channel, ootb_brand, ootb_license: Standard metadata providing context.