Create group role
/api/group/rolesCreate a role in the group on VRChat. name is required; description and permissions (VRChat's ids) are optional. One request, never retried; a refusal answers with VRChat's own message, and a 403 for a permission Modbot's VRChat account lacks names it in missingGroupPermission. Once VRChat accepts, the audit log records who created it.
Needs the ManageGroupRoles permission.
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
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/api/group/roles" \ -H "Content-Type: application/json" \ -d '{ "id": null, "name": null, "description": null, "permissions": null }'{ "role": { "id": "string", "name": null, "description": null, "permissions": [ "string" ], "order": 0, "isDefault": true, "isManagementRole": true, "isSelfAssignable": true, "requiresTwoFactor": true, "heldByModbot": true }}List group roles GET
The group's roles, read from VRChat when you ask, in VRChat's order. Each role's `permissions` are VRChat's own ids (`group-bans-manage`; `*` is every permission). `heldByModbot` says whether Modbot's VRChat account has the role, as last read. One request to VRChat per call, never retried. Needs the `ManageGroupRoles` permission.
Update group role PUT
Change a role: `id` names it. Leave `name`, `description` or `permissions` out to keep them; `permissions` is the whole list, which VRChat replaces. Only the fields that differ from what Modbot last recorded are sent. One request, never retried. Once VRChat accepts, the audit log records who changed it and each field's old and new value. Needs the `ManageGroupRoles` permission. Kept for older clients: use `PUT /api/group/roles/{id}`.