Update user group - Automate.ax

slack.updateUserGroup changes one or more user-group properties.

Example

automations/update-user-group.automation.ts

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

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

  slack.updateUserGroup({
    userGroupId: "S01234567",
    description: "Primary incident responders",
  })
})

Inputs

Requires userGroupId. Optional changes are name, handle, description, channelIds, additionalChannelIds, enableSection, and includeCount.

Output

Returns the updated user group. Requires usergroups:write, a paid Slack plan, and sufficient workspace permissions.