v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
MetricsAPI Reference
Discord

Update Permission

REQUIRES ADMIN CREDENTIALS. Updates the info on a permission.

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

PUT
/permissions/{permissionId}

Authorization

auth<token>

Auth Token via Cookie

In: cookie

Path Parameters

permissionIdstring

Must be a valid permission ID.

Request Body

name?string
ownerId?string

A users unique ID, usually in the form of usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469. Legacy players can have old IDs in the form of 8JoV9XEdpo. The ID can never be changed.

Response Body

application/json

application/json

application/json

curl -X PUT "https://api.vrchat.cloud/api/1/permissions/string" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "displayName": "string",
  "description": "string",
  "id": "prms_804ba021-9f47-4e25-9847-1f42fdb2e6ff",
  "ownerDisplayName": "string",
  "name": "permission-invite-photos",
  "ownerId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
  "type": "string",
  "data": {}
}

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

{
  "error": {
    "message": "\"Invalid Admin Credentials\"",
    "status_code": 403
  }
}