# Medals

Create and manage medals and their recipients.

# 🔐 Route

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

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

# Endpoints

# Get All Medals

Gets all medals in the guild

Request Body
No Request Body required for this request

Response

Code

Body

  {
    success: true,
    status: "OK",
    data: Medal[]
  }

# Get Medal

Gets one medal in the guild

Request Body
No Request Body required for this request

Response

Code

Body

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

# Edit Medal

Edits the contents of a medal

Request Body

{
  name: string.max(50)?;
  description: string.max(100)?;
  role: snowflake? | null;
}

Response

Code

Body

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

# Add Medal To User

Grants a medal to the specified user

Request Body

{
  medalId: string;
  robloxId: number.int();
  rankerId: number.int()?;
  reason: string.max(50)?;
}

Response

Code

Body

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

# Remove Medal From User

Removes a medal from the specified user

Request Body

{
  medalId: string;
  robloxId: number.int();
  rankerId: number.int()?;
  reason: string.max(50)?;
}

Response

Code

Body

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

# Create Medal

Creates a new medal

Request Body

{
  name: string.max(50);
  description: string.max(100);
  role: snowflake | null;
}

Response

Code

Body

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

# Delete Medal

Deletes a medal

Request Body
No Request Body required for this request

Response

Code

Body

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

# Types

# Medal Object

Medal
{
  name: string;
  description: string;
  medalId: string;
  role: snowflake | null;
  userCount: number;
}