Sign in
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' | 'partner' | 'sales_manager' | 'moderator' | 'advertiser' | 'workforce' required

The system role to grant. The Partner role can only be granted to the account's attached, verified partner.

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' | 'partner' | '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://ui-avatars.com/api/"
    },
    "username": "danawhitfield"
  }
}

Changes

Changed in 6 of the 74 revisions of this API.26

  • c19acf2e254811See the full diff
    • ●

      added the new partner enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new partner enum value to the request property

      request-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f67a043e31901See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added

  • 48408451a1f01See the full diff
    • ○

      added the new workforce enum value to the request property

      request-property-enum-value-added

  • ae20b30817de1See the full diff
    • ●

      added the new workforce enum value to the response property for the response status

      response-property-enum-value-added

  • f1020c3ecda42See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 60bbb4a6ffbc1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.