Preview roles from lists
/api/discord-list-roles/previewWho 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.
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
curl -X POST "https://example.com/api/discord-list-roles/preview" \ -H "Content-Type: application/json" \ -d '{}'{ "plans": [ { "id": null, "listId": "9fc6ad7d-902a-4834-b161-a4911b883d44", "listName": "string", "discordRoleId": "string", "roleName": null, "giving": 0, "taking": 0, "alreadyHave": 0, "takenByHand": 0, "noLinkedDiscord": 0, "notInServer": 0, "holders": 0, "leaving": 0, "takesHeld": 0, "heldBecause": null, "stops": true, "lossStops": true, "giveStops": true, "problem": null, "changes": [ { "what": "string", "discordUserId": "string", "vrChatUserId": null, "name": null } ] } ]}Update role from a list PUT
Switch one list's role on or off. Off keeps the roles it gave where they are. Needs the `ManageDiscordSync` permission.
Apply role from a list POST
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.