Skip to main content

Add custom role to player

Add a custom role to a player with a specified duration. ⚠️ This action has a cooldown of 5 seconds, per player.

Path Parameters
uuid uuid — REQUIRED

UUID of the player

roleId integer — REQUIRED

ID of the custom role to add

Request Body — REQUIRED
period string — REQUIRED

Duration period (required if type is 'period'). Available options include:

  • Minute-based: 15m (15 minutes), 30m (30 minutes), 45m (45 minutes)
  • Hour-based: 1h (1 hour), 2h (2 hours), 3h (3 hours), 4h (4 hours), 5h (5 hours), 6h (6 hours), 12h (12 hours)
  • Day-based: 1d (1 day), 2d (2 days), 3d (3 days), 4d (4 days), 5d (5 days), 6d (6 days)
  • Week-based: 1w (1 week), 2w (2 weeks), 3w (3 weeks)
  • Month-based: 1m (1 month), 2m (2 months), 3m (3 months), 4m (4 months), 5m (5 months), 6m (6 months), 7m (7 months), 8m (8 months), 9m (9 months), 10m (10 months), 11m (11 months)
  • Year-based: 1y (1 year)
  • Special: 0 (forever), eod (end of day), eow (end of week), eom (end of month), eoy (end of year)
Responses
200

successful operation

Schema — OPTIONAL
data string — OPTIONAL
400

Invalid input

Schema — OPTIONAL
error string — OPTIONAL
404

Player or role not found

Schema — OPTIONAL
error string — OPTIONAL
429

Too many requests

Schema — OPTIONAL
error string — OPTIONAL