Powered by

# Rank

Rank users within your group.

# 🔐 Route

This is an authenticated route.
It requires an auth header:

authentication
The bearer token contained in your authentication string
Example: Soldier HCYrY1MsaB2fd13

# Endpoints

# Set Rank

Sets the rank of a user

Request Body

{
  robloxId: number.int(),
  rankerId: number.int()?,
  reason: string.max(50)?,
  rank: number.int().min(1).max(255),
}

Response

Code
Body 

  {
    success: true,
    status: "OK",
    data: RankData
  }

# Promote

Promotes a user up a certain number of ranks

Request Body

{
  robloxId: number.int(),
  amount: number.int().min(1).max(5),
  rankerId: number.int()?,
  reason: string.max(50)?,
}

Response

Code
Body 

  {
    success: true,
    status: "OK",
    data: RankData
  }

# Demote

Demotes a user down a certain number of ranks

Request Body

{
  robloxId: number.int(),
  amount: number.int().min(1).max(5),
  rankerId: number.int()?,
  reason: string.max(50)?,
}

Response

Code
Body 

  {
    success: true,
    status: "OK",
    data: RankData
  }

# Types

# Rank Data

RankData
{
  rankingRequest: boolean;
  previousRank: number;
  newRank: number | null;
  rankerAccount: number;
}