Skip to main content
PATCH
/
sessions
/
update
/
{sessionId}
Update Session
curl --request PATCH \
  --url https://api.series.hr/sessions/update/{sessionId} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "Title": "<string>",
  "Description": "<string>",
  "Host": "<string>",
  "CoHost": "<string>",
  "Supervisor": "<string>",
  "Scheduled": "2023-11-07T05:31:56Z",
  "Duration": 2,
  "Claimable": true,
  "CustomRoles": [
    {
      "name": "<string>",
      "slots": 5,
      "minRank": 1,
      "permissions": {
        "ChangeSessionStatus": true,
        "PassOrFailAttendees": true,
        "ModifyAttendance": true
      }
    }
  ]
}
'
Update an existing session with new details. All fields are optional — only include the fields you want to change.

​
Request

curl -X PATCH https://api.series.hr/sessions/update/session_abc123 \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "Title": "Advanced Training Session",
    "Duration": 120,
    "CustomRoles": [
      {
        "name": "Trainer",
        "slots": 3,
        "minRank": 25,
        "permissions": {
          "ChangeSessionStatus": false,
          "PassOrFailAttendees": true,
          "ModifyAttendance": true
        }
      }
    ]
  }'

​
Parameters

​
sessionId
string
required
The session ID to update
​
Title
string
Updated session title
​
Description
string
Updated session description
​
Host
string
Updated host Roblox user ID
​
CoHost
string
Updated co-host Roblox user ID
​
Supervisor
string
Updated supervisor Roblox user ID
​
Scheduled
string
Updated ISO 8601 scheduled start time
​
Duration
integer
Updated session duration in minutes (must be a positive integer)
​
Claimable
boolean
Updated claimable status
​
CustomRoles
array
Updated custom role definitions (Premium/Enterprise only). Replaces all existing custom roles. Send an empty array [] to remove all custom roles. 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

​
200
{
  "success": true,
  "data": {
    "SessionId": "session_abc123"
  }
}
Setting CustomRoles replaces all existing custom roles and their slot assignments. Users who previously claimed slots will need to re-claim them.

Authorizations

​
apikey
string
header
required

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

Path Parameters

​
sessionId
string
required

The session ID to update

Body

application/json
​
Title
string

Updated session title

​
Description
string

Updated description

​
Host
string

Updated host user ID

​
CoHost
string

Updated co-host user ID

​
Supervisor
string

Updated supervisor user ID

​
Scheduled
string<date-time>

Updated scheduled time

​
Duration
integer

Updated duration in minutes

Required range: x >= 1
​
Claimable
boolean

Updated claimable status

​
CustomRoles
object[]

Updated custom role definitions (Premium/Enterprise only). Replaces all existing custom roles.

Response

Session updated