Modbot Docs
APIAPI referenceModeration

Ban a person

POST/api/moderation/ban

Works on anybody, member or not: VRChat's group ban takes a user id, so somebody who has never joined can be kept out before they arrive. A person Modbot has never seen is recorded as a person by the ban, and their profile is fetched afterwards. A reason is required, and the ban's case file is written from it and the note. Nothing is recorded as done unless VRChat accepted it. When Discord is set up and the person has linked their Discord account, that account is banned too, whatever the ban sync switches say; if Discord refuses, the VRChat ban stands and the answer says what Discord said. The key makes one confirmation act once.

Needs the Ban 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

application/problem+json

application/problem+json

curl -X POST "https://example.com/api/moderation/ban" \  -H "Content-Type: application/json" \  -d '{    "userId": "string",    "key": "string"  }'
{  "action": "string",  "userId": "string",  "done": true,  "at": "2019-08-24T14:15:22Z",  "caseId": null,  "error": null,  "rateLimited": true,  "repeat": true,  "gone": false,  "missingGroupPermission": null,  "discordDone": false,  "discordError": null,  "caseFileError": null}

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.