> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# Update user group

> Update a Slack user group's properties and channel preferences.

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

## Example

```ts automations/update-user-group.automation.ts theme={null}
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.