Sign in

a84d4905fdbb

latestOpenAPI 3.1.02026-08-143874115.7 MB
Team Members

Update Team Member

Changes a team member's system role. Requires a user session — account API keys cannot change member roles. The account owner's role cannot be changed, and you cannot change your own role.

patch/team_members/{id}

Request body

role'owner' | 'admin' | 'sales_manager' | 'moderator' | 'advertiser' | 'workforce' required

The system role to grant.

Example request

{
  "role": "workforce"
}

Response

Team member updated.

account_idstring required

The account this membership belongs to, prefixed biz_.

created_atstring required

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

emailstring nullable required

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

idstring required

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

is_agentboolean required

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

role'owner' | 'admin' | 'sales_manager' | 'moderator' | 'advertiser' | 'app_manager' | 'support' | 'manager' | 'workforce' | 'custom' required

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

status'joined' | 'pending' required

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

updated_atstring required

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

Example response

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "created_at": "2026-01-01T12:00:00.000Z",
  "email": "marcus@shinetime.example",
  "id": "ausr_xxxxxxxxxxxxxx",
  "role": "moderator",
  "status": "joined",
  "updated_at": "2026-01-01T12:00:00.000Z",
  "user": {
    "id": "user_xxxxxxxxxxxxxx",
    "name": "Dana Whitfield",
    "profile_picture": {
      "url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    },
    "username": "danawhitfield"
  }
}