Skip to main content
POST
Set Rank
Requires Premium or Enterprise subscription

Overview

Sets a user’s rank to a specific rank number in the linked Roblox group. This allows jumping multiple ranks at once, unlike promote/demote which move one rank at a time. The user does not need to be a workspace member - they only need to be a member of the Roblox group. For workspace members:
  • Action is logged to ranking history, audit log, and disciplinary records
  • Workspace member data is updated
  • Both promotion and demotion suggestions are cleared
For non-workspace members (group members only):
  • Action is logged to ranking history and audit log only
  • No disciplinary record is created
  • All logs indicate the action was performed via API

Path Parameters

string
required
The Roblox user ID to set rank for
integer
required
Target rank number (0-255). Must correspond to an existing role in the Roblox group.

Request Body

string
Optional reason/comment for the rank change. This will be logged in ranking history and disciplinary records.

Response

boolean
Whether the request was successful
object

Example

Response Example

Error Responses

Side Effects

When a user’s rank is set, the following actions occur automatically: For all users (workspace members and group-only members):
  1. Roblox Group Update - User’s rank in the Roblox group is updated
  2. Ranking History - Entry logged with timestamp, author, and comment
  3. Audit Log - Action logged with workspace member or group-only indicator
Additionally for workspace members only: 4. Workspace Data Update - User’s CurrentRank and CurrentRole are updated 5. Disciplinary Log - Record added to user’s disciplinary file 6. Suggestions Cleared - All pending ranking suggestions (both promotion and demotion) for the user are removed

Rank Limits

When setting a rank higher than the user’s current rank, the following limits apply:
  • Max Promotion Rank - Cannot set rank higher than this value
  • Max Auto-Ranking Rank - Cannot set rank higher than this value
These limits are configured in the workspace settings.

Use Cases

  • Reinstatement - Restore a user to their previous rank after a temporary demotion
  • Bulk Adjustments - Quickly adjust ranks during restructuring
  • Administrative Actions - Set exact ranks for special circumstances
  • Onboarding - Set new members to a specific starting rank

Rate Limit

50 requests per second per API key

Authorizations

apikey
string
header
required

Pass your API key in the apikey header. Alternatively, the x-api-key header is also accepted.

Path Parameters

userId
string
required

The Roblox user ID

rankNumber
integer
required

Target rank number (0-255)

Required range: 0 <= x <= 255

Body

application/json
comment
string

Optional reason/comment for the rank change

Response

Rank set