Skip to main content
PATCH
JavaScript

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-05-1"

Path Parameters

id
string
required

User ID (prefixed user_) or username.

Query Parameters

account_id
string

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

Body

application/json
banner
object | null
bio
string
name
string
profile_picture
object
username
string

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 GET /users/me self-view for callers with balance-read scope; null otherwise.

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 on GET /users/me; populated only for callers with balance-read scope and null otherwise. A user with no wallet activity returns an empty series.

banner
object | null
required

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

bio
string | null
required

The user's biography

created_at
string
required

When the user was created, as an ISO 8601 timestamp

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.

email
string | null
required

The user's email address. Populated only on GET /users/me self-view for callers with email-read scope; null otherwise, or while the account has no confirmed email yet.

id
string
required

User ID, prefixed user_.

name
string | null
required

The user's display name

profile_picture
object
required

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

social_accounts
object[]
required
staff
object | null
required

Whop staff access flags. Populated only on GET /users/me self-view for callers with staff-read scope; null there for every user who is not Whop staff, and always null elsewhere.

username
string
required

The user's unique username

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.

whop_partner_enabled_at
string | null
required

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