STstuut
business-units

Set Business Unit Members

Update the business unit's membership so it matches the given users, and return the resulting members. The list is the complete set, so anyone missing from it loses their membership — this covers additions and removals in a single call.

  • Pass one or more user IDs to restrict the unit to those people.
  • Pass an empty list ([]) to remove all members, leaving the unit unrestricted.

Dropping a user's last membership makes them unscoped again, so they regain visibility of every business unit. Requires organization admin.

put/v2/business-units/{business_unit_id}/members

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

business_unit_idstring required

Request body

user_idsstring[]

IDs of the users who should be members of this business unit.

Response

Successful Response

created_atstring date-time required
modified_atstring date-time required
idstring required
emailstring required
namestring required
given_namestring required
family_namestring required
profile_picturestring nullable required
role'admin' | 'member' | 'manager' required
objectstring required

String representing the object's type. Objects of the same type share the same value.

Changes

No recorded changes to this operation across all 1 revision of this API.