0

Update group membership

by
Published Oct 17, 2025

Updates a user's group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Script box Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Box = {
3
  token: string;
4
};
5
/**
6
 * Update group membership
7
 * Updates a user's group membership. Only admins of this
8
group or users with admin-level permissions will be able to
9
use this API.
10
 */
11
export async function main(
12
  auth: Box,
13
  group_membership_id: string,
14
  fields: string | undefined,
15
  body: { role?: "member" | "admin"; configurable_permissions?: {} },
16
) {
17
  const url = new URL(
18
    `https://api.box.com/2.0/group_memberships/${group_membership_id}`,
19
  );
20
  for (const [k, v] of [["fields", fields]]) {
21
    if (v !== undefined && v !== "" && k !== undefined) {
22
      url.searchParams.append(k, v);
23
    }
24
  }
25
  const response = await fetch(url, {
26
    method: "PUT",
27
    headers: {
28
      "Content-Type": "application/json",
29
      Authorization: "Bearer " + auth.token,
30
    },
31
    body: JSON.stringify(body),
32
  });
33
  if (!response.ok) {
34
    const text = await response.text();
35
    throw new Error(`${response.status} ${text}`);
36
  }
37
  return await response.json();
38
}
39