Skip to main content
Create a new session with optional scheduling, connected place ID, duration, role permissions, and recurrence parameters.
Request body fields support both PascalCase (e.g. PlaceId, AutoRankPassers) and camelCase (e.g. placeId, autoRankPassers) naming conventions.

​
Request

​
Parameters

​
string
required
Session title (alias: title)
​
string
required
ISO 8601 scheduled start time (alias: scheduledDate)
​
integer
required
Session duration in minutes (must be a positive integer, alias: duration)
​
string | integer
Roblox Place ID (connected place) for automated server detection and live attendance tracking (alias: placeId)
​
boolean
Automatically rank up members in Roblox who pass attendance upon session conclusion (alias: autoRankPassers, default: false)
​
string
Roblox user ID of the host (optional if Claimable is true, must be a workspace member, alias: host)
​
string
Detailed session description (optional, alias: description)
​
string
Roblox user ID of the co-host (optional, alias: coHost)
​
string
Roblox user ID of the supervisor (optional, alias: supervisor)
​
boolean
Whether host position can be claimed by eligible workspace members (alias: claimable, default: false)
​
integer
Minimum group rank required to claim host position (0-255, required if Claimable is true, alias: minHostRank)
​
integer
Minimum group rank required for co-host position (0-255, alias: minCoHostRank)
​
integer
Minimum group rank required for supervisor position (0-255, alias: minSupervisorRank)
​
object
Custom default permissions for the host role (Premium/Enterprise only, alias: hostPermissions):
  • ChangeSessionStatus (boolean): Can start, delay, cancel, or end the session (default: true)
  • PassOrFailAttendees (boolean): Can mark attendees as passed or failed (default: true)
  • ModifyAttendance (boolean): Can add or remove attendees (default: true)
​
object
Custom default permissions for the co-host role (Premium/Enterprise only, alias: coHostPermissions):
  • ChangeSessionStatus (boolean): Can start, delay, cancel, or end the session (default: false)
  • PassOrFailAttendees (boolean): Can mark attendees as passed or failed (default: true)
  • ModifyAttendance (boolean): Can add or remove attendees (default: false)
​
object
Custom default permissions for the supervisor role (Premium/Enterprise only, alias: supervisorPermissions):
  • ChangeSessionStatus (boolean): Can start, delay, cancel, or end the session (default: false)
  • PassOrFailAttendees (boolean): Can mark attendees as passed or failed (default: false)
  • ModifyAttendance (boolean): Can add or remove attendees (default: false)
​
boolean
Set to true to create a series of recurring sessions (alias: isRecurring, default: false)
​
string
Recurrence interval when Recurring is true. One of: daily, weekly, monthly, yearly (alias: frequency)
​
integer
Number of recurring session instances to generate (must be an integer >= 2, alias: count)
​
array
Array of custom role definitions (Premium/Enterprise only, alias: customRoles). 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

​
For recurring sessions (Recurring: true), the response includes SessionIds containing all created occurrence IDs.