Update user group members - Automate.ax

slack.updateUserGroupMembers replaces the group’s complete membership list.

Example

automations/update-user-group-members.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { slack } from "automate.ax/slack"

export default automation("Update user group members", () => {
  onDashboardRun({ title: "Update user group members" })

  slack.updateUserGroupMembers({
    userGroupId: "S01234567",
    userIds: ["U01234567", "U07654321"],
  })
})

Inputs

Requires userGroupId and a non-empty userIds array. includeCount asks Slack to include the resulting member count. Slack does not allow this method to remove every member; disable the group instead.

Output

Returns the updated user group. Guests and bot users cannot be members. Requires usergroups:write and sufficient workspace permissions.