0

Update User Group Members

by
Published today

Replace the members of a user group. Requires usergroups:write; usually a user token, since workspace settings often block bots.

Script slack Verified

The script

Submitted by hugo989 Bun
Verified 5 hours ago
1
import { WebClient } from "@slack/web-api"
2

3
/**
4
 * Update User Group Members
5
 * Replace the full member list of a user group (e.g. @oncall) with the given user IDs — users not listed are removed. Workspace settings decide who may edit user groups; a bot token often gets permission_denied, so use a user token from someone allowed to. Requires usergroups:write on the connection.
6
 */
7
export async function main(auth: RT.Slack, usergroup: string, users: string[]) {
8
  const client = new WebClient(auth.token)
9
  return await client.usergroups.users.update({
10
    usergroup,
11
    users: users.join(","),
12
  })
13
}
14