Skip to main content
PATCH
TypeScript

Authorizations

Authorization
string
header
required

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

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-10-29-8"

Path Parameters

id
string
required

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

Body

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.

Available options:
owner,
admin,
partner,
sales_manager,
moderator,
advertiser,
workforce
Example:

"partner"

Response

Team member updated.

account_id
string
required

The account this membership belongs to, prefixed biz_.

Example:

"biz_xxxxxxxxxxxxxx"

authorized_role
object | null
required

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

created_at
string
required

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.

Example:

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

direct_reports_count
integer | null
required

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

Example:

0

email
string | null
required

The member's email address. For an invite sent to an email with no Whop account yet, the invited address; for accepted members and invites to an existing Whop account, null unless the caller holds the company:authorized_user:email:read scope.

Example:

"marcus@shinetime.example"

id
string
required

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.

Example:

"ausr_xxxxxxxxxxxxxx"

is_agent
boolean
required

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

Example:

false

reports_to_id
string | null
required

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.

Example:

"ausr_xxxxxxxxxxxxxx"

role
enum<string>
required

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

Available options:
owner,
admin,
partner,
sales_manager,
moderator,
advertiser,
app_manager,
support,
manager,
workforce,
custom
Example:

"admin"

status
enum<string>
required

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

Available options:
joined,
pending
Example:

"joined"

updated_at
string
required

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

Example:

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

user
object | null
required

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