v6 documentation is incomplete, want to contribute?

Add Favorite

Add a new favorite.

Friend groups are named group_0 through group_3. Avatar and World groups are named avatars1 to avatars4 and worlds1 to worlds4.

You cannot add people whom you are not friends with to your friends list. Destroying a friendship removes the person as favorite on both sides.

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

POST
/favorites
auth<token>

Auth Token via Cookie

In: cookie

typestring
Default"friend"
Value in"world" | "friend" | "avatar"
favoriteIdstring

Must be either AvatarID, WorldID or UserID.

tagsarray<Tag>

Tags indicate which group this favorite belongs to. Adding multiple groups makes it show up in all. Removing it from one in that case removes it from all.

Response Body

application/json

application/json

application/json

curl -X POST "https://api.vrchat.cloud/api/1/favorites" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "friend",
    "favoriteId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
    "tags": [
      "group_0"
    ]
  }'
{
  "favoriteId": "string",
  "id": "fvrt_9568d189-8776-44a5-a8c8-defc981e44de",
  "tags": [
    "string"
  ],
  "type": "world"
}

{
  "error": {
    "message": "You already have that friend favorited",
    "status_code": 400
  }
}

{
  "error": {
    "message": "you are not friends with that userǃ",
    "status_code": 403
  }
}