v6 documentation is incomplete, want to contribute?

Request Invite

Requests an invite from a user. Returns the Notification of type requestInvite that was sent.

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

POST
/requestInvite/{userId}
auth<token>

Auth Token via Cookie

In: cookie

Path Parameters

userIdstring

Must be a valid user ID.

Slot number of the Request Message to use when request an invite.

requestSlot?integer
Range0 <= value <= 11

Response Body

application/json

application/json

curl -X POST "https://api.vrchat.cloud/api/1/requestInvite/string" \
  -H "Content-Type: application/json" \
  -d '{}'

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

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