Skip to main content
POST
/
sessions
/
v2
/
{sessionId}
/
servers
/
{serverId}
/
claims
Claim a role
curl --request POST \
  --url https://api.readmin.app/sessions/v2/{sessionId}/servers/{serverId}/claims \
  --header 'Content-Type: application/json' \
  --header 'loader-id: <api-key>' \
  --data '
{
  "userId": "<string>",
  "roleGroupId": "<string>",
  "roleId": "<string>"
}
'
{
  "success": true,
  "data": {
    "userId": "<string>",
    "roleId": "<string>",
    "roleName": "<string>",
    "claimedBy": "<string>",
    "claimedAt": "2023-11-07T05:31:56Z",
    "claimId": "<string>"
  }
}

Authorizations

​
loader-id
string
header
required

Path Parameters

​
sessionId
string
required

The session id.

​
serverId
string
required

The server id.

Body

application/json
​
userId
string
required

Roblox user id claiming the role.

​
roleGroupId
string
required

Id of the role group (see GET /sessions/v2/roles).

​
roleId
string
required

Id of the subrole within the role group.

Response

Role claimed

​
success
boolean
default:true
​
data
object