Modbot Docs

Preview staff roles from Discord

POST/api/staff-roles/preview

Who would gain or lose a role if the mappings were these. Changes nothing.

Needs the ManageUsers and ManageRoles 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/staff-roles/preview" \  -H "Content-Type: application/json" \  -d '{    "mappings": [      {        "id": null,        "discordRoleId": "string",        "roleId": "7382d58e-652a-4905-b7c9-bcca1e0e5391",        "direction": "string"      }    ]  }'
{  "covered": 0,  "wouldStop": true,  "changes": [    {      "what": "string",      "userId": null,      "name": null,      "discordUserId": null,      "roleName": "string",      "discordRoleName": null,      "byHand": true,      "why": "string"    }  ],  "notes": [    {      "what": "string",      "userId": null,      "name": null,      "discordUserId": null,      "roleName": "string",      "discordRoleName": null,      "byHand": true,      "why": "string"    }  ],  "problems": [    "string"  ]}

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.