Skip to main content
POST
Create Session
Create a new session with optional scheduling and duration parameters.

Request

Parameters

string
required
Session title
string
required
ISO 8601 scheduled start time
integer
required
Session duration in minutes (must be a positive integer)
string
Roblox user ID of the host (optional, must be a workspace member)
string
Detailed session description (optional)
string
Roblox user ID of the co-host (optional)
string
Roblox user ID of the supervisor (optional)
boolean
Whether users can claim attendance (default: false)
array
Array of custom role definitions (Premium/Enterprise only). Each role object has:
  • name (string, required): Role name (must be unique, cannot be “Host”, “CoHost”, or “Supervisor”)
  • slots (integer, required): Number of slots (1-10)
  • minRank (integer, optional): Minimum rank requirement (default: 0)
  • permissions (object, optional): Role permissions
    • ChangeSessionStatus (boolean): Can start/delay/cancel/end the session
    • PassOrFailAttendees (boolean): Can mark attendees as passed/failed
    • ModifyAttendance (boolean): Can manage the attendance list

Response

Authorizations

apikey
string
header
required

Pass your API key in the apikey header. Alternatively, the x-api-key header is also accepted.

Body

application/json
Title
string
required

Session title

Example:

"Training Session"

Scheduled
string<date-time>
required

Session start time in ISO 8601 format

Duration
integer
required

Duration in minutes (positive integer)

Required range: x >= 1
Description
string

Detailed session description

Host
string

Roblox user ID of the host (optional, must be a workspace member)

Example:

"714760171"

CoHost
string

Roblox user ID of co-host (optional)

Supervisor
string

Roblox user ID of supervisor (optional)

Claimable
boolean

Whether users can claim attendance (default: false)

CustomRoles
object[]

Custom role definitions (Premium/Enterprise only)

Response

Session created