User Group Operations
resource: userGroup — 7 operations for managing Slack user groups (subteams)
Underlying API: Slack's
usergroups.* Web API methods.
create
Creates a new user group via usergroups.create.
| Field | Required | Notes |
|---|---|---|
name | Yes | Display name of the group. |
handle | No | @-mention handle. |
description | No | Group description. |
channels | No | Comma-separated channel IDs the group defaults into. |
update
Updates group fields via usergroups.update. Only non-null fields are sent.
| Field | Required | Notes |
|---|---|---|
userGroupId | Yes | Target group. |
name, handle, description | No | Fields to change; omitted fields keep their current value. |
enable / disable
enable (usergroups.enable) and disable (usergroups.disable) both take a single required field: userGroupId.
getMany
Lists all user groups via usergroups.list.
| Field | Required | Default | Notes |
|---|---|---|---|
includeDisabled | No | false | Include disabled groups in the results. |
includeCount | No | true | Include each group's member count. |
getUsers
Lists the members of a group via usergroups.users.list.
| Field | Required | Notes |
|---|---|---|
userGroupId | Yes | Target group. |
includeDisabled | No | Include members whose accounts are disabled. |
addUsers
Sets the full membership list —
usergroups.users.update is a replace operation, not an append. Existing members not included in userIds are removed from the group.
| Field | Required | Notes |
|---|---|---|
userGroupId | Yes | Target group. |
userIds | Yes | Comma-separated Slack user IDs — becomes the complete membership list. |