Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Headers

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-07-20"

Body

application/json
account_id
string
required

Account ID, prefixed biz_.

role
enum<string>
required

The system role to grant.

Available options:
owner,
admin,
sales_manager,
moderator,
advertiser
user_id
string
required

The user to add to the team, prefixed user_.

Response

Team member created.

account_id
string
required

The account this membership belongs to, prefixed biz_.

created_at
string
required

When the member joined or the invite was sent, as an ISO 8601 timestamp.

email
string | null
required

The member's email address. For accepted members, null unless the caller holds the email read scope; for invites, the invited address.

id
string
required

Team member ID — ausr_ for accepted members, ausri_ for pending invites.

is_agent
boolean
required

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

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,
sales_manager,
moderator,
advertiser,
app_manager,
support,
manager,
custom
Example:

"owner"

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.

user
object | null
required

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