Skip to main content
PATCH
Quit Custom Role
Quit a custom role that the user currently holds. The slot will be made vacant again for other users to claim. The 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 quitting the role (must be a workspace member)
string
required
The name of the custom role to quit

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 quitting the role

RoleName
string
required

Name of the custom role to quit

Response

Custom role quit successfully