Modbot Docs
APIAPI referenceSettings

Preview roles from lists

POST/api/discord-list-roles/preview

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.

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

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        }      ]    }  ]}

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.