Update User - Whop Docs

TypeScript

import { WhopClient } from "@whop/sdk";

const client = new WhopClient({ token: "YOUR_TOKEN", apiVersionDate: "2026-08-21-1", idempotencyKey: "YOUR_IDEMPOTENCY_KEY" });
await client.users.update({
    id: "id"
});

curl --request PATCH \
  --url https://api.whop.com/api/v1/users/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "banner": {
    "direct_upload_id": "eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "id": "file_xxxxxxxxxxxxxx"
  },
  "bio": "Interior specialist. Leather, upholstery, and odor removal.",
  "name": "Tanya Cole",
  "profile_picture": {
    "direct_upload_id": "eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "id": "file_xxxxxxxxxxxxxx"
  },
  "username": "tanyacole"
}
'

import requests

url = "https://api.whop.com/api/v1/users/{id}"

payload = {
    "banner": {
        "direct_upload_id": "eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "id": "file_xxxxxxxxxxxxxx"
    },
    "bio": "Interior specialist. Leather, upholstery, and odor removal.",
    "name": "Tanya Cole",
    "profile_picture": {
        "direct_upload_id": "eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "id": "file_xxxxxxxxxxxxxx"
    },
    "username": "tanyacole"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    banner: {
      direct_upload_id: 'eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
      id: 'file_xxxxxxxxxxxxxx'
    },
    bio: 'Interior specialist. Leather, upholstery, and odor removal.',
    name: 'Tanya Cole',
    profile_picture: {
      direct_upload_id: 'eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
      id: 'file_xxxxxxxxxxxxxx'
    },
    username: 'tanyacole'
  })
};

fetch('https://api.whop.com/api/v1/users/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/users/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'banner' => [
        'direct_upload_id' => 'eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
        'id' => 'file_xxxxxxxxxxxxxx'
    ],
    'bio' => 'Interior specialist. Leather, upholstery, and odor removal.',
    'name' => 'Tanya Cole',
    'profile_picture' => [
        'direct_upload_id' => 'eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
        'id' => 'file_xxxxxxxxxxxxxx'
    ],
    'username' => 'tanyacole'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/users/{id}"

	payload := strings.NewReader("{\n  \"banner\": {\n    \"direct_upload_id\": \"eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"id\": \"file_xxxxxxxxxxxxxx\"\n  },\n  \"bio\": \"Interior specialist. Leather, upholstery, and odor removal.\",\n  \"name\": \"Tanya Cole\",\n  \"profile_picture\": {\n    \"direct_upload_id\": \"eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"id\": \"file_xxxxxxxxxxxxxx\"\n  },\n  \"username\": \"tanyacole\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.whop.com/api/v1/users/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"banner\": {\n    \"direct_upload_id\": \"eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"id\": \"file_xxxxxxxxxxxxxx\"\n  },\n  \"bio\": \"Interior specialist. Leather, upholstery, and odor removal.\",\n  \"name\": \"Tanya Cole\",\n  \"profile_picture\": {\n    \"direct_upload_id\": \"eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"id\": \"file_xxxxxxxxxxxxxx\"\n  },\n  \"username\": \"tanyacole\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/users/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"banner\": {\n    \"direct_upload_id\": \"eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"id\": \"file_xxxxxxxxxxxxxx\"\n  },\n  \"bio\": \"Interior specialist. Leather, upholstery, and odor removal.\",\n  \"name\": \"Tanya Cole\",\n  \"profile_picture\": {\n    \"direct_upload_id\": \"eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"id\": \"file_xxxxxxxxxxxxxx\"\n  },\n  \"username\": \"tanyacole\"\n}"

response = http.request(request)
puts response.read_body

{
  "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": null,
        "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.",
  "cards": {
    "kind": "individual",
    "status": "approved"
  },
  "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"
    },
    "partners": {
      "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": "marcus@shinetime.example",
  "id": "user_xxxxxxxxxxxxxx",
  "name": "Marcus Webb",
  "profile_picture": {
    "url": "https://ui-avatars.com/api/"
  },
  "staff": {
    "admin": true,
    "investigation_access": true,
    "manager": false,
    "support": false
  },
  "trading": {
    "account_id": "<string>",
    "hyperliquid": {
      "address": "<string>",
      "websocket_subscriptions": [
        {
          "channel": "clearinghouse_state",
          "message": "<string>"
        }
      ],
      "websocket_url": "<string>"
    },
    "id": "<string>",
    "object": "trading_account",
    "provider": "hyperliquid",
    "user_id": "<string>"
  },
  "username": "marcuswebb",
  "verification": {
    "business": null,
    "individual": null
  },
  "whop_partner_enabled_at": "2026-01-01T12:00:00.000Z",
  "whop_partner_onboarded_accounts_count": 1,
  "whop_partner_verified_at": "2026-01-01T12:00:00.000Z"
}

PATCH

users

{id}

TypeScript

import { WhopClient } from "@whop/sdk";

const client = new WhopClient({ token: "YOUR_TOKEN", apiVersionDate: "2026-08-21-1", idempotencyKey: "YOUR_IDEMPOTENCY_KEY" });
await client.users.update({
    id: "id"
});

curl --request PATCH \
  --url https://api.whop.com/api/v1/users/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "banner": {
    "direct_upload_id": "eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "id": "file_xxxxxxxxxxxxxx"
  },
  "bio": "Interior specialist. Leather, upholstery, and odor removal.",
  "name": "Tanya Cole",
  "profile_picture": {
    "direct_upload_id": "eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "id": "file_xxxxxxxxxxxxxx"
  },
  "username": "tanyacole"
}
'

import requests

url = "https://api.whop.com/api/v1/users/{id}"

payload = {
    "banner": {
        "direct_upload_id": "eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "id": "file_xxxxxxxxxxxxxx"
    },
    "bio": "Interior specialist. Leather, upholstery, and odor removal.",
    "name": "Tanya Cole",
    "profile_picture": {
        "direct_upload_id": "eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "id": "file_xxxxxxxxxxxxxx"
    },
    "username": "tanyacole"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    banner: {
      direct_upload_id: 'eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
      id: 'file_xxxxxxxxxxxxxx'
    },
    bio: 'Interior specialist. Leather, upholstery, and odor removal.',
    name: 'Tanya Cole',
    profile_picture: {
      direct_upload_id: 'eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
      id: 'file_xxxxxxxxxxxxxx'
    },
    username: 'tanyacole'
  })
};

fetch('https://api.whop.com/api/v1/users/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/users/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'banner' => [
        'direct_upload_id' => 'eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
        'id' => 'file_xxxxxxxxxxxxxx'
    ],
    'bio' => 'Interior specialist. Leather, upholstery, and odor removal.',
    'name' => 'Tanya Cole',
    'profile_picture' => [
        'direct_upload_id' => 'eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
        'id' => 'file_xxxxxxxxxxxxxx'
    ],
    'username' => 'tanyacole'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/users/{id}"

	payload := strings.NewReader("{\n  \"banner\": {\n    \"direct_upload_id\": \"eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"id\": \"file_xxxxxxxxxxxxxx\"\n  },\n  \"bio\": \"Interior specialist. Leather, upholstery, and odor removal.\",\n  \"name\": \"Tanya Cole\",\n  \"profile_picture\": {\n    \"direct_upload_id\": \"eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"id\": \"file_xxxxxxxxxxxxxx\"\n  },\n  \"username\": \"tanyacole\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.whop.com/api/v1/users/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"banner\": {\n    \"direct_upload_id\": \"eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"id\": \"file_xxxxxxxxxxxxxx\"\n  },\n  \"bio\": \"Interior specialist. Leather, upholstery, and odor removal.\",\n  \"name\": \"Tanya Cole\",\n  \"profile_picture\": {\n    \"direct_upload_id\": \"eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"id\": \"file_xxxxxxxxxxxxxx\"\n  },\n  \"username\": \"tanyacole\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/users/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"banner\": {\n    \"direct_upload_id\": \"eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"id\": \"file_xxxxxxxxxxxxxx\"\n  },\n  \"bio\": \"Interior specialist. Leather, upholstery, and odor removal.\",\n  \"name\": \"Tanya Cole\",\n  \"profile_picture\": {\n    \"direct_upload_id\": \"eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"id\": \"file_xxxxxxxxxxxxxx\"\n  },\n  \"username\": \"tanyacole\"\n}"

response = http.request(request)
puts response.read_body

{
  "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": null,
        "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.",
  "cards": {
    "kind": "individual",
    "status": "approved"
  },
  "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"
    },
    "partners": {
      "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": "marcus@shinetime.example",
  "id": "user_xxxxxxxxxxxxxx",
  "name": "Marcus Webb",
  "profile_picture": {
    "url": "https://ui-avatars.com/api/"
  },
  "staff": {
    "admin": true,
    "investigation_access": true,
    "manager": false,
    "support": false
  },
  "trading": {
    "account_id": "<string>",
    "hyperliquid": {
      "address": "<string>",
      "websocket_subscriptions": [
        {
          "channel": "clearinghouse_state",
          "message": "<string>"
        }
      ],
      "websocket_url": "<string>"
    },
    "id": "<string>",
    "object": "trading_account",
    "provider": "hyperliquid",
    "user_id": "<string>"
  },
  "username": "marcuswebb",
  "verification": {
    "business": null,
    "individual": null
  },
  "whop_partner_enabled_at": "2026-01-01T12:00:00.000Z",
  "whop_partner_onboarded_accounts_count": 1,
  "whop_partner_verified_at": "2026-01-01T12:00:00.000Z"
}

Authorizations

Authorization

string

header

required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Api-Version-Date

string

Pins the request to a dated API version.

Example:

"2026-10-09-1"

Path Parameters

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, or when include_balance=false.

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."

cards

object | null

required

Where the user's personal card application stands. Populated only on the self view (retrieved with the reserved id me) for callers with balance-read scope; null otherwise, or when the user has never applied for a card.

Show child attributes

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, including a Partner commission breakdown. Populated only on single-user self reads for callers with balance-read scope; null otherwise.

Show child attributes

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:

"marcus@shinetime.example"

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

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

trading

object | null

required

The trading account address and its WebSocket subscriptions. Opt in with include_trading=true when retrieving me. null otherwise, without trading permission, or without an Ethereum wallet.

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"

whop_partner_onboarded_accounts_count

integer | null

required

Number of accounts the user referred to Whop as a Whop Partner that have processed more than $1 in volume attributed to the user. Populated only when retrieving a single user who is a Verified Whop Partner; null otherwise.

Example:

1

whop_partner_verified_at

string | null

required

When the user became a Verified Whop Partner, as an ISO 8601 timestamp. null for users who are not Verified Whop Partners, including partners who left the program and suspended users.

Example:

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