Skip to main content

Overview

The UnbanPlayer function allows staff members to remove existing bans from players. This function requires appropriate permissions and logs all unban actions for accountability.

UnbanPlayer

Remove an existing ban from a player using their identifier.

Syntax

Parameters

  • staffId (number) - Server ID of the staff member performing the unban
  • identifier (string) - Player identifier (Steam ID, Discord ID, etc.)
  • reason (string, optional) - Reason for the unban

Returns

  • success (boolean) - Whether the unban was successful
  • status (string) - Status code: 'success', 'no_permission', 'not_banned', 'invalid_identifier'

Example

Advanced Examples

Unban with Player Lookup

Mass Unban System

Temporary Unban (Probation System)

Error Handling