Modbot Docs
APIAPI referenceDiscord

Time out on Discord

POST/api/discord/members/{id}/timeout

Time one member of the Discord server out for minutes (1 to 40320, which is 28 days); a member already timed out gets the new length. The address names their Discord id; reason goes to Discord's audit log with your account's name. One request, never retried. Once Discord accepts, the audit log records who asked. Never the bot's own account, the server's owner or a Discord account linked to a Modbot staff account: those answer 403 refused.

Needs the DiscordTimeOut permission.

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

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

application/problem+json

curl -X POST "https://example.com/api/discord/members/string/timeout" \  -H "Content-Type: application/json" \  -d '{    "minutes": 0  }'
{  "changed": true}

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.