Modbot Docs
APIAPI referenceSettings

Purge a person

POST/api/settings/purge

Irreversible. confirmation must equal subjectId exactly.

Erased: every fact where they are the subject, the counted-only daily totals dimensioned on them, the rows saying a record about them was imported, their Discord messages including earlier texts of edited ones, and their standing giveaway entries. Their place in a past draw keeps its position and weight and loses its name and ids, so an old result still checks out.

Kept: facts where they were the actor rather than the subject — somebody else's moderation history — case files about them with their evidence and profile snapshots (evidence storage design §15.1), the current-state rows the next sync would write again, and the fact that this purge happened.

A purge of somebody Modbot has never seen removes nothing and is not an error.

Needs the Administrator permission.

AuthorizationBearer <token>

An API key, made on Settings, API keys. Every key starts with mbk_.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/api/settings/purge" \  -H "Content-Type: application/json" \  -d '{    "platform": "string",    "subjectId": "string",    "confirmation": "string"  }'
{  "facts": 0,  "countedDailyTotals": 0,  "days": 0,  "messages": 0,  "giveawayEntries": 0,  "giveawayPlaces": 0,  "caseFilesKept": 0,  "evidenceFilesKept": 0}

Modbot is not endorsed by or affiliated with VRChat Inc. or Discord Inc. VRChat is a trademark of VRChat Inc. Discord is a trademark of Discord Inc. SteamVR is a trademark of Valve Corporation. Windows is a trademark of Microsoft Corporation. Docker is a trademark of Docker, Inc. PostgreSQL is a trademark of the PostgreSQL Community Association of Canada. Railway is a trademark of Railway Corp. Other names are trademarks of their respective owners; see Legal. Modbot and its logo are trademarks of the Modbot project. Open source under AGPL-3.0.