Skip to main content
PATCH
Remove From Custom Role
Remove a user from a custom role they currently hold. The slot will be made vacant again. This is an administrative action. The target user must be a workspace member.
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 to remove from the role (must be a workspace member)
string
required
The name of the custom role to remove the user from

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
TargetUserId
string
required

Roblox user ID of the user to remove

RoleName
string
required

Name of the custom role to remove the user from

Response

User removed from custom role successfully