Update role from a list
/api/discord-list-roles/{id}Switch one list's role on or off. Off keeps the roles it gave where they are.
Needs the ManageDiscordSync permission.
An API key, made on Settings, API keys. Every key starts with mbk_.
In: header
Path Parameters
uuidRequest 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 PUT "https://example.com/api/discord-list-roles/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "enabled": true }'{ "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}Delete role from a list DELETE
Stop a list giving a Discord role. Nobody loses the role: Modbot forgets who it gave it to, and the role stays with everybody who has it. Needs the `ManageDiscordSync` permission.
Preview roles from lists POST
Who would be given a list's Discord role and who would lose it right now, and how many in the list have no linked Discord account or are not in the server. Changes nothing. One saved pairing by `id`, one not saved yet by `listId` and `discordRoleId`, or every pairing that is on. Needs the `ViewMembers` and `ViewProfile` and `ManageDiscordSync` permissions.