Type Alias: CreateGatheringRequest
Properties
| Property | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Human-readable name for the gathering (example: "Friday Game Night") |
type | "lobby" | "appointment" | "open" | Yes | Type of gathering (example: "lobby") |
maxMembers | number | No | Maximum number of members (2-100) (example: 8) |
accessPolicy | "public" | "private" | "invite-only" | No | Access policy for joining (example: "public") |
listed | boolean | No | Whether gathering appears in public search (example: false) |
startsAt | string | No | Scheduled start time (for appointments) (example: "2024-01-20T15:00:00Z") |
endsAt | string | No | Scheduled end time (for appointments) (example: "2024-01-20T16:00:00Z") |
timezone | string | No | Timezone for scheduled times (IANA format) (example: "Europe/Berlin") |
autoStartSession | boolean | No | Whether to auto-start transcription session when gathering starts (example: true) |
properties | object | No | Custom properties (game mode, lobby settings, etc.) (example: {"gameMode":"deathmatch","map":"dust2"}) |
searchProperties | object | No | Indexed search properties for discovery (example: {"gameMode":"deathmatch","skillLevel":1200}) |
roomId | string | No | Custom room ID for ODIN. If not provided, the join code will be used as the room ID. (example: "game-room-lobby-123") |
ownerId | string | No | Participant UUID of the gathering owner. If not provided, the creator becomes the owner. |
description | string | No | Description providing context about the gathering (shown in invitation emails) (example: "Weekly team sync to discuss project progress and blockers.") |
invitationUrl | string | No | URL where participants join the meeting (e.g., Rooms instance URL). Used in invitation emails and calendar entries as the location. (example: "https://myapp.rooms.chat/room/abc123") |
participants | InvitedParticipant[] | No | List of participants to invite. Each invitee receives an email invitation. For Appointment gatherings with a start date, a calendar invite (.ics) is attached. |
inviterName | string | No | Display name of the person organizing the gathering. Shown as "Invited by {name}" in invitation emails and used as the ORGANIZER CN in calendar invites. (example: "Alice Smith") |
inviterEmail | string | No | Email address of the person organizing the gathering. Used as the Reply-To address in invitation emails and as the ORGANIZER mailto in calendar invites so recipients can reply directly to the inviter. (example: "alice@example.com") |
Defined in
4Players/cortex-typescript-sdk/src/resources/gatherings.ts:18