v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

Create GroupRole

Create a Group role.

Requests made through this page are proxied through an intermediary server due to Cross-Origin Resource Sharing restrictions.

POST
/groups/{groupId}/roles

Authorization

auth<token>

Auth Token via Cookie

In: cookie

Path Parameters

groupIdstring

Must be a valid group ID.

Request Body

id?string
name?string
description?string
isSelfAssignable?boolean
Defaultfalse
permissions?array<GroupPermissions>

Response Body

application/json

application/json

application/json

curl -X POST "https://api.vrchat.cloud/api/1/groups/grp_00000000-0000-0000-0000-000000000000/roles" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "id": "grol_459d3911-f672-44bc-b84d-e54ffe7960fe",
  "groupId": "grp_71a7ff59-112c-4e78-a990-c7cc650776e5",
  "name": "string",
  "description": "string",
  "isSelfAssignable": false,
  "permissions": [
    "*"
  ],
  "isManagementRole": false,
  "requiresTwoFactor": false,
  "requiresPurchase": false,
  "order": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "error": {
    "message": "\"Missing Credentials\"",
    "status_code": 401
  }
}

{
  "error": {
    "message": "Can't find groupǃ",
    "status_code": 404
  }
}