POST /unban/{user_id}
Endpoint: POST /v1/pdapi/unban/<user_id>
Auth: Bearer token
Permission: REST.Punishments.Unban
Purpose
Unbans a user ID in Banlist.json.
Path parameters
user_id: User ID to unban.
Query parameters
None.
Request body
Optional JSON field: Reason string.
Response schema
200 response schema
| Field | Type | Description |
|---|---|---|
Success |
boolean | true when the active user ban was removed. |
UserId |
string | User ID that was unbanned. |
Error responses
Error bodies use this shape:
| HTTP | Error code | When it happens |
|---|---|---|
401 |
INVALID_TOKEN |
The Authorization header is missing, malformed, or does not match a configured bearer token. |
403 |
MISSING_PERMISSION |
The token is valid, but it does not include this endpoint permission. |
400 |
INVALID_JSON |
A request body was supplied, but it could not be parsed as JSON. |
400 |
REQUEST_FAILED |
The game-thread callback threw an exception, or a shared player/resource resolver failed. |
500 |
REQUEST_TIMEOUT |
The internal game-thread callback did not complete within 5 seconds. |
400 |
VALIDATION_FAILED |
An optional request field has the wrong JSON type. |
404 |
BAN_NOT_FOUND |
The supplied user_id is not actively banned. |
Examples
Unban a Steam user
Unban a PS5 user with default reason
Scenarios
- Remove a user ban after appeal approval.
- Keep a reason for the audit trail.
- Use GET /banlist with
userIdorqto verify the result.