0

Remove Users from User Group

by
Published Oct 17, 2025

Removes one or multiple users or invites from a user group by email.

Script segment Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Segment = {
3
  token: string;
4
  baseUrl: string;
5
};
6
/**
7
 * Remove Users from User Group
8
 * Removes one or multiple users or invites from a user group by email.
9
 */
10
export async function main(
11
  auth: Segment,
12
  userGroupId: string,
13
  emails: string | undefined,
14
) {
15
  const url = new URL(`${auth.baseUrl}/group/${userGroupId}/users`);
16
  for (const [k, v] of [["emails", emails]]) {
17
    if (v !== undefined && v !== "" && k !== undefined) {
18
      url.searchParams.append(k, v);
19
    }
20
  }
21
  const response = await fetch(url, {
22
    method: "DELETE",
23
    headers: {
24
      Authorization: "Bearer " + auth.token,
25
    },
26
    body: undefined,
27
  });
28
  if (!response.ok) {
29
    const text = await response.text();
30
    throw new Error(`${response.status} ${text}`);
31
  }
32
  return await response.json();
33
}
34