Skip to main content
PATCH
Update Member

Autorisations

Authorization
string
header
requis

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.

Scopes

member:manage
user:notifications:update

En-têtes

Api-Version-Date
string

Pins the request to a dated API version.

Exemple:

"2026-11-17"

Paramètres de chemin

id
string
requis

Member ID (mber_ tag).

Corps

application/json
metadata
object | null

Your own key-value data on this member. Up to 50 keys of at most 100 characters. Values are strings of at most 500 characters, numbers, true, false, or null. At most 200 KB. Replaces existing metadata, and null clears it. Requires member:manage.

Exemple:
name
string | null

The name invoices show for this member, in place of the user's own. null clears it. Requires member:manage.

Maximum string length: 255
Exemple:

"Northwind Legal LLP"

unsubscribe_status
enum<string> | null

unsubscribed to opt out of the account's marketing, null to opt back in. Only the member can set it, with user:notifications:update.

Options disponibles:
unsubscribed,
null
Exemple:

"unsubscribed"

Réponse

member resubscribed from their own session

access_level
enum<string>
requis

What the member can reach on the account: customer for paying members, admin for team members, no_access once every grant has lapsed.

Options disponibles:
no_access,
admin,
customer
Exemple:

"customer"

account_id
string
requis

The account this member belongs to, prefixed biz_.

Exemple:

"biz_xxxxxxxxxxxxxx"

created_at
string
requis

When the member record was created, as an ISO 8601 timestamp.

Exemple:

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

display_name
string
requis

The name to show for this member: the user's name, or their username when they have not set one. The buying business's name when user is null.

Exemple:

"Dana Whitfield"

earnings_usd
object | null
requis

The user's gross income across Whop, in USD, refreshed periodically. null when the user hides their earnings or the buyer is another business.

email
string | null
requis

The user's email address. null without member:email:read on the account, when the buyer is another business, or when the user has no assigned email.

Exemple:

"marcus@shinetime.example"

id
string
requis

Member ID, prefixed mber_.

Exemple:

"mber_xxxxxxxxxxxxxx"

joined_at
string
requis

When the member first joined the account, as an ISO 8601 timestamp.

Exemple:

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

last_accessed_at
string | null
requis

When the member last opened the account's content, as an ISO 8601 timestamp. null if they never have.

Exemple:

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

last_activity
Message · object | null
requis

What happened at last_activity_at. object says which kind of activity it is. null without support_chat:read on the account, or when last_activity_at is null.

last_activity_at
string | null
requis

When the member and the account last interacted, as an ISO 8601 timestamp. For example, a message in the member's support chat.

Exemple:

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

metadata
object | null
requis

Your own key-value data stored on this member. null when none is set.

Exemple:

null

most_recent_action
enum<string> | null
requis

The member's latest lifecycle state on the account, derived from their memberships, such as paid_subscriber, canceling, or churned. null until it is first computed.

Options disponibles:
canceling,
churned,
finished_split_pay,
paused,
paid_subscriber,
paid_once,
expiring,
joined,
left,
trialing,
pending_entry,
renewing,
past_due,
null
Exemple:

"paid_subscriber"

most_recent_action_at
string | null
requis

When most_recent_action took effect, as an ISO 8601 timestamp. null when most_recent_action is null.

Exemple:

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

name
string | null
requis

The name the account gave this customer with PATCH /members/:id. Invoices show it as the customer name on every invoice for this member, in place of the user's own name. null when the account has not set one.

Exemple:

"Northwind Legal LLP"

phone_number
string | null
requis

The member's phone number: the most recent number collected (or verified) at checkout, otherwise their account number when they have shared one with this seller. null without member:phone:read on the account, or when there is neither.

Exemple:

"+xxxxxxxxxxx"

status
enum<string>
requis

joined while the member is part of the account, left after they leave.

Options disponibles:
joined,
left
Exemple:

"joined"

token_balance
number
requis

The member's current token balance for this account, computed from token transactions.

Exemple:

70.25

unsubscribe_status
enum<string> | null
requis

unsubscribed once the member opts out of the account's marketing communications, null while they're subscribed. Only the member can change it.

Options disponibles:
unsubscribed,
null
Exemple:

"unsubscribed"

usd_total_spent
object
requis

How much the member has spent on the account's products, in USD.

user
object | null
requis

The user behind this member. null when the buyer is another business rather than a person.