Skip to main content
PATCH
TypeScript

Autorisations

Authorization
string
header
requis

Only available to a signed-in whop.com session. API keys, access tokens, and OAuth tokens are not accepted.

Scopes

authorized_user: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

Team member ID. Accepted members have an ID starting with ausr_ or mber_, and pending invites one starting with ausri_. Treat it as opaque.

Corps

application/json
role
enum<string>

The system role to grant. Custom roles cannot be granted through the API. The Partner role provides view-only access.

Options disponibles:
owner,
admin,
partner,
sales_manager,
moderator,
advertiser,
workforce
Exemple:

"partner"

Réponse

Team member updated.

account
object
requis

The account this membership belongs to.

authorized_role
object | null
requis

Custom role assigned to this member, or null when the member has a system role.

created_at
string
requis

When the member joined the team or the invite was sent, as an ISO 8601 timestamp. A member who was a customer first keeps the date they were given their role.

Exemple:

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

direct_reports_count
integer | null
requis

How many team members report directly to this member. null for invites.

Exemple:

0

email
string | null
requis

The member's email address. For an invite to an email with no Whop account yet, this is the invited address. Otherwise it is null unless the caller holds the company:authorized_user:email:read scope.

Exemple:

"marcus@shinetime.example"

id
string
requis

Team member ID. Accepted members have an ID starting with ausr_ or mber_, and pending invites one starting with ausri_. Treat it as opaque: both member prefixes are accepted wherever a team member ID is.

Exemple:

"ausr_xxxxxxxxxxxxxx"

is_agent
boolean
requis

Whether this member is an agent (app-controlled account) rather than a human team member. Always false for invites.

Exemple:

false

is_partner
boolean
requis

Whether this member or invite has the view-only Partner role, directly or through a custom role based on it. A Partner can read only the account's basic details.

Exemple:

false

reports_to_chain
object[] | null
requis
reports_to_id
string | null
requis

The ID of the team member this member reports to, starting with ausr_ or mber_; treat it as opaque. null when the member reports to the business directly, and for invites.

Exemple:

"ausr_xxxxxxxxxxxxxx"

role
enum<string>
requis

The member's role on the account. custom means a bespoke dashboard-managed role; the API can read but not grant it.

Options disponibles:
owner,
admin,
partner,
sales_manager,
moderator,
advertiser,
app_manager,
support,
manager,
workforce,
custom
Exemple:

"admin"

status
enum<string>
requis

joined for accepted members, pending while the invite is pending.

Options disponibles:
joined,
pending
Exemple:

"joined"

updated_at
string
requis

When the membership was last updated, as an ISO 8601 timestamp.

Exemple:

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

user
object | null
requis

The user behind this team membership. null for an invite sent to an email with no Whop account yet.