Update automatic role
/api/settings/automatic-roles/{id}Replace a rule's settings.
Needs the ManageSettings 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
application/problem+json
curl -X PUT "https://example.com/api/settings/automatic-roles/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "name": null, "vrChatRoleId": null, "discordRoleId": null, "wholeTeam": true, "whoDiscordRoleIds": null, "whoVRChatRoleIds": null, "companionRunning": true, "clipsReady": true, "inGroupInstance": true, "minimumLevel": true, "minimumLevelPassedTrial": true, "minimumLevelStaffRoleId": null, "overturnedBans": true, "overturnedBansMax": null, "overturnedBansDays": null, "dailyBanCap": true, "dailyBanCapMax": null, "missedClips": true, "missedClipsMax": null, "missedClipsDays": null, "takeBackUserIds": null }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": null, "vrChatRoleId": null, "discordRoleId": null, "wholeTeam": true, "whoDiscordRoleIds": [ "string" ], "whoVRChatRoleIds": [ "string" ], "companionRunning": true, "clipsReady": true, "inGroupInstance": true, "minimumLevel": true, "minimumLevelPassedTrial": true, "minimumLevelStaffRoleId": null, "overturnedBans": true, "overturnedBansMax": null, "overturnedBansDays": null, "dailyBanCap": true, "dailyBanCapMax": null, "missedClips": true, "missedClipsMax": null, "missedClipsDays": null, "takeBackUserIds": [ "de2d6ce0-69d9-44fe-98c1-ebd39ce82ebe" ], "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}Delete automatic role DELETE
Delete a rule. Needs the `ManageSettings` permission.
List who holds an automatic role GET
Modbot accounts that hold the rule's role in Modbot's copy of the group and server members, and accounts the rule applies to that do not hold it. A rule that gives both a VRChat and a Discord role lists each account once per role. `given` says whether Modbot has an open grant for the role (`byModbot`), not (`byHand`), or the account does not hold it (`notHeld`). `ruleMet` says whether every condition is met, and `conditions` lists each condition the rule switches on with whether it is met and the numbers behind it. Needs the `ManageSettings` permission.