Update User

Updates a user, addressed by user_ tag, username, or the reserved id me for the authenticated user. A user token updates their own global profile; an API key updates the user’s account-specific profile override (account_id required).

PATCH /users/{id}

JavaScript

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const user = await client.users.update('id');

console.log(user.id);

200

{
  "balance": {
    "businesses": [
      {
        "balance_usd": "18940.25",
        "id": "biz_xxxxxxxxxxxxxx",
        "logo_url": "https://assets.whop.com/logos/shine-time-auto-detailing.png",
        "name": "Shine Time Auto Detailing"
      }
    ],
    "businesses_total_usd": "18940.25",
    "cash": [
      {
        "balance": 4385.75,
        "balance_usd": 4385.75,
        "currency": "usd",
        "in_transit_balance_usd": 0,
        "pending_balance_usd": 310,
        "price_usd": 123,
        "reserve_balance_usd": 125,
        "total_withdrawable_balance": 4385.75
      }
    ],
    "cash_usd": "0.00",
    "crypto": [
      {
        "balance": "1500.0",
        "breakdown": {
          "available": "1500.0",
          "in_transit": "0",
          "pending": "0",
          "pending_settlements": [
            {
              "amount": "12.5",
              "date": "2026-01-01"
            }
          ],
          "reserve": "0"
        },
        "icon_url": "https://assets.whop.com/tokens/usdt.png",
        "name": "Tether USD",
        "price_usd": 1,
        "symbol": "USDT",
        "value_usd": 1500
      }
    ],
    "crypto_usd": "0.00",
    "pending_usd": "0.00",
    "total_usd": "0.00",
    "treasury_pending_usd": "0.00"
  },
  "balance_history": {
    "data": [
      {
        "t": 1767268800,
        "v": 2400
      }
    ],
    "last": 0,
    "max": 0,
    "min": 0
  },
  "banner": {
    "url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  },
  "bio": "Ceramic coating specialist. Detailing cars in Austin since 2016.",
  "created_at": "2026-01-01T12:00:00.000Z",
  "earnings_usd": {
    "first_earned_at": "2026-01-01T12:00:00.000Z",
    "owned_accounts": {
      "last_24_hours": "0.00",
      "last_30_days": "260.00",
      "last_7_days": "60.00",
      "lifetime": "4120.25"
    },
    "personal": {
      "last_24_hours": "0.00",
      "last_30_days": "260.00",
      "last_7_days": "60.00",
      "lifetime": "4120.25"
    },
    "total": {
      "last_24_hours": "0.00",
      "last_30_days": "260.00",
      "last_7_days": "60.00",
      "lifetime": "4120.25"
    }
  },
  "email": "[e-mail]",
  "id": "user_xxxxxxxxxxxxxx",
  "name": "Marcus Webb",
  "profile_picture": {
    "url": "https://ui-avatars.com/api/"
  },
  "social_accounts": [
    {
      "error": "You don't have permission to share this account. Ask an admin of its Meta Business Portfolio to grant you full control, then share it again.",
      "external_id": "1234567891",
      "id": "sacc_xxxxxxxxxxxxxx",
      "name": "Shine Time Auto Detailing",
      "parent_social_account": {
        "external_id": "555111",
        "id": "sacc_xxxxxxxxxxxxxx",
        "name": "Shine Time Auto Detailing",
        "platform": "facebook",
        "profile_picture_url": "https://shinetime.example/logo.png",
        "username": "shinetimedetailing",
        "verified": true
      },
      "platform": "instagram",
      "profile_picture_url": "https://shinetime.example/logo.png",
      "scopes": [
        "advertise"
      ],
      "url": "https://instagram.com/shinetimedetail",
      "username": "shinetimedetail",
      "verified": true
    }
  ],
  "staff": {
    "admin": true,
    "investigation_access": true,
    "manager": false,
    "support": false
  },
  "username": "marcuswebb",
  "verification": {
    "business": null,
    "individual": null
  },
  "whop_partner_enabled_at": "2026-01-01T12:00:00.000Z"
}

Authorizations

Authorization · string · header · required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date · string

Pins the request to a dated API version.

Example:

"2026-08-21"

Path Parameters

id · string · required

User ID (prefixed user_), username, or me for the authenticated user.

Query Parameters

account_id · string

The account whose profile override to update. Required for API key callers.

Body

application/json

banner · object | null

Show child attributes

bio · string

Example:

"Interior specialist. Leather, upholstery, and odor removal."

name · string

Example:

"Tanya Cole"

profile_picture · object

Show child attributes

username · string

Example:

"tanyacole"

Response

200 - application/json

user updated

balance · object | null · required

The user's balance: personal cash + crypto + in-flight treasury deposits, plus account balances for accounts they own. Computed only on the self view (retrieved with the reserved id me) for callers with balance-read scope; null otherwise.

Show child attributes

balance_history · object | null · required

The user's cumulative wallet balance over time (USD { t, v } points plus last/min/max), for the balance chart. Opt in with include_balance_history=true when retrieving yourself with the reserved id me; populated only for callers with balance-read scope and null otherwise. A user with no wallet activity returns an empty series.

Show child attributes

banner · object | null · required

The user's profile banner wrapper. null when the user has no banner.

Show child attributes

bio · string | null · required

The user's biography

Example:

"Ceramic coating specialist. Detailing cars in Austin since 2016."

created_at · string · required

When the user was created, as an ISO 8601 timestamp

Example:

"2026-01-01T12:00:00.000Z"

earnings_usd · object | null · required

The user's gross USD income over time. Populated only on single-user self reads for callers with balance-read scope; null otherwise.

Show child attributes

email · string | null · required

The user's email address. Populated only on the self view (retrieved with the reserved id me) for callers with email-read scope; null otherwise, or while the account has no confirmed email yet.

Example:

"[e-mail]"

id · string · required

User ID, prefixed user_.

Example:

"user_xxxxxxxxxxxxxx"

name · string | null · required

The user's display name

Example:

"Marcus Webb"

profile_picture · object · required

Avatar wrapper; its url is always present, using a generated placeholder when the user set no picture.

Show child attributes

social_accounts · object[] · required

Show child attributes

staff · object | null · required

Whop staff access flags. Populated only on the self view (retrieved with the reserved id me) for callers with staff-read scope; null there for every user who is not Whop staff, and always null elsewhere.

Show child attributes

username · string · required

The user's unique username

Example:

"marcuswebb"

verification · object · required

Identity verification status for the user's individual (KYC) and business (KYB) profiles. Each is null until created, otherwise a status of not_started, pending, approved, or rejected.

Example:

{ "business": null, "individual": null }

whop_partner_enabled_at · string | null · required

When the user became an enrolled Whop Partner, as an ISO 8601 timestamp. null if never enrolled.

Example:

"2026-01-01T12:00:00.000Z"