v6 documentation is incomplete, want to contribute?

Invite User to Group

Sends an invite to a user to join the group.

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

POST
/groups/{groupId}/invites
auth<token>

Auth Token via Cookie

In: cookie

Path Parameters

groupIdstring

Must be a valid group ID.

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.

confirmOverrideBlock?boolean
Defaulttrue

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/invites" \
  -H "Content-Type: application/json" \
  -d '{
    "userId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469"
  }'
Empty

{
  "error": {
    "message": "User <displayName> is already a member of this group.",
    "status_code": 400
  }
}

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

{
  "error": {
    "message": "You can't invite that user․",
    "status_code": 403
  }
}

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