Modbot Docs
APIAPI referenceSettings

Apply role from a list

POST/api/discord-list-roles/{id}/apply

Let a list's role carry on after it stopped because it would take the role from many people at once, or give it to most of the server. taking, leaving and giving are what the preview showed; refused if more would go now. Nothing is sent from here: the next pass, within a minute, makes the changes, and the allowance shrinks as they are made.

Needs the ViewMembers and ViewProfile and RunDiscordSync permissions.

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string
Formatuuid

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

curl -X POST "https://example.com/api/discord-list-roles/497f6eca-6276-4993-bfeb-53cbbbba6f08/apply" \  -H "Content-Type: application/json" \  -d '{    "taking": 0  }'
{  "on": true,  "botCanManageRoles": true,  "ranAt": null,  "problem": null,  "roles": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "listId": "9fc6ad7d-902a-4834-b161-a4911b883d44",      "listName": "string",      "discordRoleId": "string",      "roleName": null,      "enabled": true,      "given": 0,      "problem": null,      "stoppedAt": null,      "stoppedTaking": null,      "removalsAllowed": null    }  ],  "lists": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string"    }  ],  "canPreview": true,  "canApply": 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.