Remove Channel Member
mattermost.remove_channel_member
ActionChat & messagingconnection required
Calls the Mattermost API with the connection's credentials.
Remove a user from a channel.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- Mattermost
- Secret shape
- the personal access token, or {"token": "…"}
- Config it needs
- base_url, team_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 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 |
|---|---|---|---|---|---|
channel_id The channel id (not its name) — use mattermost.get_channel_by_name to resolve one. | string | Yes | — | — | — |
user_id The user to remove from the channel. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
removed True when Mattermost accepted the removal. | boolean | — |
channel_id The channel that was changed. | string | — |
user_id The user that was removed. | string | — |
{
"channel_id": "",
"removed": false,
"user_id": ""
}See Remove Channel Member run in a workflow.
In a technical demo we add the Mattermost connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.