Type Alias: CreateSanctionRequest
Properties
| Property | Type | Required | Description |
|---|---|---|---|
participantId | string | No | Participant ID to sanction (for session-scoped sanctions) (example: "550e8400-e29b-41d4-a716-446655440000") |
externalUserId | string | No | External user ID from ODIN (for cross-session sanctions) (example: "user_abc123") |
sessionId | string | No | Session ID (for session-scoped sanctions) (example: "550e8400-e29b-41d4-a716-446655440001") |
type | "warn" | "mute" | "listen_only" | "text_only" | "rate_limit" | "shadow_mute" | "temp_ban" | "perm_ban" | "ranked_restriction" | "queue_delay" | "party_restriction" | "human_review" | Yes | Type of sanction to apply (example: "mute") |
scope | object | No | Scope configuration for channel-specific sanctions (example: {"channels":["team","proximity"]}) |
reason | string | No | Reason for the sanction (example: "Repeated use of profanity detected by automated filter") |
metadata | object | No | Additional metadata (evidence, AI confidence, etc.) (example: {"confidence":0.95,"triggeredBy":"profanity_filter"}) |
startAt | string | No | When the sanction starts (defaults to now) (example: "2024-01-15T10:00:00Z") |
endAt | string | No | When the sanction ends (null = permanent) (example: "2024-01-15T11:00:00Z") |
Defined in
4Players/cortex-typescript-sdk/src/resources/sanctions.ts:17