Skip to main content
PATCH
Claim Custom Role
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

Parameters

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

Response

Errors

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