v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

Invite User

Sends an invite to a user. Returns the Notification of type invite that was sent.

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

POST
/invite/{userId}

Authorization

auth<token>

Auth Token via Cookie

In: cookie

Path Parameters

userIdstring

Must be a valid user ID.

Request Body

Slot number of the Invite Message to use when inviting a user.

instanceIdstring

InstanceID can be "offline" on User profiles if you are not friends with that user and "private" if you are friends and user is in private instance.

messageSlot?integer
Range0 <= value <= 11

Response Body

application/json

application/json

curl -X POST "https://api.vrchat.cloud/api/1/invite/string" \
  -H "Content-Type: application/json" \
  -d '{
    "instanceId": "12345~hidden(usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469)~region(eu)~nonce(27e8414a-59a0-4f3d-af1f-f27557eb49a2)"
  }'

{
  "id": "frq_00000000-0000-0000-0000-000000000000",
  "receiverUserId": "usr_00000000-0000-0000-0000-000000000000",
  "senderUserId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
  "type": "friendRequest",
  "message": "",
  "details": {},
  "created_at": "2021-01-01T00:00:00.000Z"
}

{
  "error": {
    "message": "\"You need to be friends with that user first.\"",
    "status_code": 403
  }
}