v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

Ban Group Member

Bans a user from a Group.

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

POST
/groups/{groupId}/bans

Authorization

auth<token>

Auth Token via Cookie

In: cookie

Path Parameters

groupIdstring

Must be a valid group ID.

Request Body

userIdstring

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

application/json

curl -X POST "https://api.vrchat.cloud/api/1/groups/grp_00000000-0000-0000-0000-000000000000/bans" \
  -H "Content-Type: application/json" \
  -d '{
    "userId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469"
  }'
{
  "acceptedByDisplayName": "string",
  "acceptedById": "string",
  "id": "gmem_95cdb3b4-4643-4eb6-bdab-46a4e1e5ce37",
  "groupId": "grp_71a7ff59-112c-4e78-a990-c7cc650776e5",
  "userId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
  "isRepresenting": true,
  "user": {
    "id": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
    "displayName": "string",
    "thumbnailUrl": "string",
    "iconUrl": "string",
    "profilePicOverride": "string",
    "currentAvatarThumbnailImageUrl": "string",
    "currentAvatarTags": [
      "string"
    ]
  },
  "roleIds": [
    "grol_459d3911-f672-44bc-b84d-e54ffe7960fe"
  ],
  "mRoleIds": [
    "grol_459d3911-f672-44bc-b84d-e54ffe7960fe"
  ],
  "joinedAt": "2019-08-24T14:15:22Z",
  "membershipStatus": "member",
  "visibility": "visible",
  "isSubscribedToAnnouncements": false,
  "isSubscribedToEventAnnouncements": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "bannedAt": "2019-08-24T14:15:22Z",
  "managerNotes": "string",
  "lastPostReadAt": "2019-08-24T14:15:22Z",
  "hasJoinedFromPurchase": true
}

{
  "error": {
    "message": "User is already banned․",
    "status_code": 400
  }
}

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

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