v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
MetricsAPI Reference
Discord

Create Permission

REQUIRES ADMIN CREDENTIALS. Creates and returns a new Permission. The permission will by default be owned by the sender of the request unless otherwise specified.

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

POST
/permissions

Authorization

auth<token>

Auth Token via Cookie

In: cookie

Query Parameters

n?integer

The number of objects to return.

Default60
Range1 <= value <= 100
offset?integer

A zero-based offset from the default object sorting from where search results start.

Range0 <= value
ownerId?string

Owner of the Permission, MUST be valid UserID.

Request Body

namestring
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 POST "https://api.vrchat.cloud/api/1/permissions?n=60&offset=0&ownerId=string" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string"
  }'
{
  "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
  }
}