v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

Update User Info

Update a users information such as the email and birthday.

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

PUT
/users/{userId}

Authorization

auth<token>

Auth Token via Cookie

In: cookie

Path Parameters

userIdstring

Must be a valid user ID.

Request Body

email?string
unsubscribe?boolean
birthday?string
Formatdate
acceptedTOSVersion?integer
tags?array<Tag>
status?string

Defines the User's current status, for example "ask me", "join me" or "offline. This status is a combined indicator of their online activity and privacy preference.

Default"offline"
Value in"active" | "join me" | "ask me" | "busy" | "offline"
statusDescription?string
bio?string
Length0 <= length
bioLinks?array<string>
pronouns?string
Length0 <= length <= 32
isBoopingEnabled?boolean
userIcon?string

MUST be a valid VRChat /file/ url.

Length0 <= length
contentFilters?array<Tag>

These tags begin with content_ and control content gating

displayName?string

MUST specify currentPassword as well to change display name

revertDisplayName?boolean

MUST specify currentPassword as well to revert display name

password?string

MUST specify currentPassword as well to change password

currentPassword?string

Response Body

application/json

application/json

application/json

curl -X PUT "https://api.vrchat.cloud/api/1/users/string" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "acceptedTOSVersion": 7,
  "acceptedPrivacyVersion": 0,
  "accountDeletionDate": "2019-08-24",
  "accountDeletionLog": [
    {
      "message": "Deletion requested",
      "deletionScheduled": "2019-08-24T14:15:22Z",
      "dateTime": "2019-08-24T14:15:22Z"
    }
  ],
  "activeFriends": [
    "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469"
  ],
  "ageVerificationStatus": "hidden",
  "ageVerified": true,
  "allowAvatarCopying": true,
  "authToken": "string",
  "badges": [
    {
      "assignedAt": "2019-08-24T14:15:22Z",
      "badgeDescription": "string",
      "badgeId": "bdg_a60e514a-8cb7-4702-8f24-2786992be1a8",
      "badgeImageUrl": "string",
      "badgeName": "string",
      "hidden": true,
      "showcased": true,
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "bio": "string",
  "bioLinks": [
    "string"
  ],
  "contentFilters": [
    "string"
  ],
  "currentAvatar": "avtr_912d66a4-4714-43b8-8407-7de2cafbf55b",
  "currentAvatarImageUrl": "https://api.vrchat.cloud/api/1/file/file_ae46d521-7281-4b38-b365-804b32a1d6a7/1/file",
  "currentAvatarThumbnailImageUrl": "https://api.vrchat.cloud/api/1/image/file_aae83ed9-d42d-4d72-9f4b-9f1e41ed17e1/1/256",
  "currentAvatarTags": [
    "string"
  ],
  "date_joined": "2019-08-24",
  "developerType": "none",
  "displayName": "string",
  "emailVerified": true,
  "fallbackAvatar": "avtr_912d66a4-4714-43b8-8407-7de2cafbf55b",
  "friendGroupNames": [
    "string"
  ],
  "friendKey": "string",
  "friends": [
    "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469"
  ],
  "hasBirthday": true,
  "hideContentFilterSettings": true,
  "userLanguage": "string",
  "userLanguageCode": "string",
  "hasEmail": true,
  "hasLoggedInFromClient": true,
  "hasPendingEmail": true,
  "homeLocation": "wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd",
  "id": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
  "isAdult": true,
  "isBoopingEnabled": true,
  "isFriend": false,
  "last_activity": "2019-08-24T14:15:22Z",
  "last_login": "2019-08-24T14:15:22Z",
  "last_mobile": "2019-08-24T14:15:22Z",
  "last_platform": "standalonewindows",
  "obfuscatedEmail": "string",
  "obfuscatedPendingEmail": "string",
  "oculusId": "string",
  "googleId": "string",
  "googleDetails": {},
  "picoId": "string",
  "viveId": "string",
  "offlineFriends": [
    "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469"
  ],
  "onlineFriends": [
    "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469"
  ],
  "pastDisplayNames": [
    {
      "displayName": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "presence": {
    "avatarThumbnail": "string",
    "currentAvatarTags": "string",
    "displayName": "string",
    "debugflag": "string",
    "groups": [
      "grp_71a7ff59-112c-4e78-a990-c7cc650776e5"
    ],
    "id": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
    "instance": "string",
    "instanceType": "string",
    "isRejoining": "string",
    "platform": "string",
    "profilePicOverride": "string",
    "status": "string",
    "travelingToInstance": "string",
    "travelingToWorld": "wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd:12345~hidden(usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469)~region(eu)~nonce(27e8414a-59a0-4f3d-af1f-f27557eb49a2)",
    "userIcon": "string",
    "world": "wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd"
  },
  "platform_history": [
    {
      "isMobile": true,
      "platform": "string",
      "recorded": "2019-08-24T14:15:22Z"
    }
  ],
  "profilePicOverride": "string",
  "profilePicOverrideThumbnail": "string",
  "pronouns": "string",
  "pronounsHistory": [
    "string"
  ],
  "queuedInstance": "string",
  "receiveMobileInvitations": true,
  "state": "offline",
  "status": "active",
  "statusDescription": "string",
  "statusFirstTime": true,
  "statusHistory": [
    "string"
  ],
  "steamDetails": {},
  "steamId": "string",
  "tags": [
    "string"
  ],
  "twoFactorAuthEnabled": true,
  "twoFactorAuthEnabledDate": "2019-08-24T14:15:22Z",
  "unsubscribe": true,
  "updated_at": "2019-08-24T14:15:22Z",
  "userIcon": "string",
  "username": "string"
}
{
  "error": {
    "message": "string",
    "status_code": 100
  }
}

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