Update User Group Members
slack.update_usergroup_users
ActionChat & messagingconnection required
Calls the Slack Web API with the connection's bot token.
Replace a user group's membership with the exact list of ids given.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Slack
- Secret shape
- the Slack bot token (xoxb-…), or {"token": "xoxb-…"}
- Resolved by
- config.connection_id, else node.connection_id
Configuration
4 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
usergroup The user group id (S…), as emitted by slack.list_usergroups. | string | Yes | — | — | — |
users Comma-separated user ids that make up the group's entire membership. | string | Yes | — | — | — |
include_count Ask Slack to include the member count in the response. | boolean | No | false | — | — |
team_id Workspace the group lives in. Only needed with an org-wide token. | string | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"include_count": false
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The user group id (S…). | string | — |
name The group's display name. | string | — |
handle The @-mention handle, without the @. | string | — |
description The group's description. | string | — |
team_id The workspace the group belongs to. | string | — |
user_count How many members Slack reports, when it reports one. | number | — |
date_delete Non-zero when the group is disabled. | number | — |
users The member ids after the update. | array | — |
{
"date_delete": 0,
"description": "",
"handle": "",
"id": "",
"name": "",
"team_id": "",
"user_count": 0,
"users": []
}Notes
- The bot must be a member of a private channel before it can act there (Slack answers not_in_channel otherwise).
- Slack rate-limits each Web API method on its own tier; a throttled call fails with the number of seconds to wait and is safe for the node's retry policy to repeat.
- This replaces the membership rather than adding to it — read the current list with slack.list_usergroup_users first if you mean to add one person.
Templates that use Slack
See Update User Group Members run in a workflow.
In a technical demo we add the Slack connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.