Modbot Docs
APIAPI referenceSettings

Add role from a list

POST/api/discord-list-roles

Give a Discord role to everybody in a saved list who is in the server, and take it from those it gave it to once they leave the list. Refused for @everyone, a bot's role, a role the bot cannot give, a role with a staff permission, a role something else already gives, and a list that lets everybody in. Needs what the preview needs, since saving follows it.

Needs the ViewMembers and ViewProfile and ManageDiscordSync permissions.

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/discord-list-roles" \  -H "Content-Type: application/json" \  -d '{    "listId": "9fc6ad7d-902a-4834-b161-a4911b883d44",    "discordRoleId": null  }'
{  "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.