v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

Moderate User

Moderate a user, e.g. unmute them or show their avatar.

Please see the Player Moderation docs on what playerModerations are, and how they differ from staff moderations.

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

POST
/auth/user/playermoderations

Authorization

auth<token>

Auth Token via Cookie

In: cookie

Request Body

moderatedstring

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.

typestring
Default"unmute"
Value in"mute" | "unmute" | "block" | "unblock" | "interactOn" | "interactOff"

Response Body

application/json

application/json

curl -X POST "https://api.vrchat.cloud/api/1/auth/user/playermoderations" \
  -H "Content-Type: application/json" \
  -d '{
    "moderated": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
    "type": "unmute"
  }'
{
  "created": "2019-08-24T14:15:22Z",
  "id": "pmod_25551a8d-6f5d-430a-88d3-9c0ce08b5244",
  "sourceDisplayName": "string",
  "sourceUserId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
  "targetDisplayName": "string",
  "targetUserId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
  "type": "unmute"
}

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