Sentinel Documentation
SDKSubscribeInvite Sentinel
  • GETTING STARTED
    • About Sentinel
    • What's a workspace?
    • Getting Started with Sentinel
      • Linking an Experience
  • 🛡️ Is Sentinel Safe to Use? Addressing Your Security Concerns
  • INFORMATION
    • Features
      • Cross-Platform Tool Suite
      • Account Linking
      • Role Synchronization
      • Advanced Analytics
    • How to get a Discord Role Id
    • Sentinel Roles: Flexible Permission Management
    • Using Sentinel's CRON Jobs to Automatically Unban Players Through Roblox Open Cloud API
    • Anti-Raid Protection & AI Content Moderator by Nebula Labs
    • Role Sync: Automatically Assign Discord Roles Based on Roblox Data
    • AI Content Moderator: Smart Civility
  • Luau SDK
    • BanAPI Documentation
  • RankingAPI Docuemtation
  • EvidenceAPI Documentation
  • DiscordAPI Documentation
  • Open Cloud API
    • Open Cloud API Introduction
    • v1
      • Models
        • BanInfo
      • Routes
        • BansAPI
          • /is-banned
          • /ban-async
          • /pending-bans
          • /pending-unbans
          • /bans
          • /unban-async
          • /export/bans/json
          • /export/bans/csv
        • RankingAPI
          • /group-role
        • EvidenceAPI
          • /evidence/create
          • /evidence/{evidenceGuid}
          • /evidence/{evidenceGuid}/metadata
    • METALink Registry API
  • Webhooks
    • Introduction to Webhooks
    • Security & Authentication for Webhooks
    • Default Payload Schema
    • Payload Dummies
      • DISCORD_BANNED
      • DISCORD_UNBANNED
      • GAME_BAN_UPDATED
      • GAME_BANNED
      • GAME_UNBANNED
  • Blogs
    • 🚀 Introducing Sentinel Tickets: Revolutionizing Discord Support
    • 🚨 Sentinel Evidence System is Now Live for Premium Users! 🚨
    • Sentinel February Update
  • 🚀 Coming Soon: April Platform Update – Sentinel Bot Development
  • March Update
  • AI Content Moderator Beta
  • Legal
    • 6 Month Retention Policy
    • Term's of Service
    • Privacy Policy
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Open Cloud API
  2. v1
  3. Routes
  4. RankingAPI

/group-role

PreviousRankingAPINextEvidenceAPI

Last updated 2 months ago

Was this helpful?

An premium membership plan for the workspace is required to use this endpoint!

Change Group Rank

patch
Authorizations
Body
userIdnumberRequired

Roblox User ID

groupIdnumberRequired

Roblox Group ID

rankIdnumberRequired

Roblox Rank ID (1-255) not Role ID.

Responses
200
User was ranked
application/json
402
Workspace does not have Tier 2 (Premium) membership or higher.
application/json
500
An error occured while communicating with Roblox.com to change rank. This usually happens as either; * Roblox is down * Your Roblox Open Cloud API key cannot access that Group * You did not link an Roblox Open Cloud API key * Your Roblox Open Cloud API key is expired
application/json
patch
PATCH /api/v1/group-role HTTP/1.1
Host: sentinel.metatable.dev
Authorization: Bearer BearerJwt
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "userId": 1,
  "groupId": 1,
  "rankId": 1
}
{
  "status": "ok"
}