Skip to main content
PATCH
/
sessions
/
{sessionId}
/
custom-roles
/
claim
Claim Custom Role
curl --request PATCH \
  --url https://api.series.hr/sessions/{sessionId}/custom-roles/claim \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "UserId": "<string>",
  "RoleName": "<string>",
  "SlotKey": "<string>"
}
'
Claim a vacant custom role slot in a session. The user must meet the minimum rank requirement for the role, and the session must be claimable.
Custom roles are a Premium/Enterprise feature. This endpoint will return a 403 error for free-tier workspaces.

​
Request

curl -X PATCH https://api.series.hr/sessions/session_abc123/custom-roles/claim \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "UserId": "714760171",
    "RoleName": "Trainer",
    "SlotKey": "VACANT_0"
  }'

​
Parameters

​
sessionId
string
required
The session ID
​
UserId
string
required
The Roblox user ID of the user claiming the slot (must be a workspace member)
​
RoleName
string
required
The name of the custom role to claim
​
SlotKey
string
required
The slot key to claim (must be a vacant slot, e.g. VACANT_0, VACANT_1)

​
Response

​
200
{
  "success": true,
  "data": {
    "message": "Successfully claimed Trainer position",
    "SessionId": "session_abc123",
    "RoleName": "Trainer",
    "UserId": "714760171"
  }
}

​
Errors

StatusDescription
400Session is not claimable, slot is already filled, or user already holds a slot in this role
403Premium/Enterprise subscription required, or user does not meet minimum rank requirement
404Session or custom role not found

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

Body

application/json
​
UserId
string
required

Roblox user ID of the user claiming the slot

​
RoleName
string
required

Name of the custom role to claim

​
SlotKey
string
required

The vacant slot key (e.g. VACANT_0, VACANT_1)

Response

Custom role claimed successfully