Purge a person
/api/settings/purgeIrreversible. 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.
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}Preview a purge GET
What a purge of one person would erase, and what it would keep. Counts only; nothing is changed. Every number is counted from the same tables the purge writes to. A field Modbot cannot answer for a platform is null rather than zero: a Discord account has no group ban list and no case files. Needs the `Administrator` permission.
Get public address GET
The address people use to reach this Modbot, and the platform's suggestion. Needs the `ManageSettings` permission.