Actions60
- User Actions
- Channel Actions
- Accept Invite
- Add Members
- Add Moderators
- Archive
- Ban User
- Create
- Delete
- Delete File
- Delete Image
- Demote Moderators
- Disable Slow Mode
- Enable Slow Mode
- Get Config
- Hide
- Invite Members
- Mark Read
- Mark Unread
- Mute
- Mute Status
- Pin
- Query Channels
- Query Members
- Reject Invite
- Remove Members
- Send Action
- Send File
- Send Image
- Show
- Stop Watching
- Truncate
- Unarchive
- Unban User
- Unmute
- Unpin
- Update
- Watch
- Message Actions
- Moderation Actions
Overview
The node performs server-side operations on Stream Chat channels, enabling management of channel membership and other channel-related actions. Specifically, the Add Members operation allows adding one or more users to an existing chat channel. This is useful in scenarios where you want to dynamically update group chats or team channels by including additional participants.
Practical examples include:
- Adding new team members to a project discussion channel.
- Including users in a broadcast or livestream channel for announcements.
- Expanding 1-on-1 messaging channels into group conversations by adding more members.
This operation requires specifying the channel type and ID to identify the target channel, along with a list of user IDs to add as members.
Properties
| Name | Meaning |
|---|---|
| Channel Type | The type of the channel. Common options: "messaging" (1-on-1 chats), "team" (group channels), "livestream" (broadcast channels). |
| Channel ID | Unique identifier for the channel (e.g., "general", "random", "team-alpha"). Combined with the channel type to form the full channel identifier (CID). |
| Members | Comma-separated list of user IDs to add as members to the channel (e.g., "john_doe,jane_smith,admin123"). No spaces around commas. |
Output
The output JSON contains the response from the Stream Chat API after attempting to add members to the specified channel. It typically includes details about the updated channel state, such as the current list of members and channel metadata.
If the operation fails, the output may contain an error message describing the issue.
No binary data is produced by this operation.
Dependencies
- Requires a valid API key credential for authenticating with the Stream Chat service.
- The node uses the Stream Chat server-side client library to perform operations.
- Proper permissions must be granted to the API credentials to modify channel memberships.
Troubleshooting
Common issues:
- Invalid or missing channel type or channel ID will cause the operation to fail.
- Providing user IDs that do not exist in the Stream Chat system may result in errors or no effect.
- Insufficient API permissions can prevent adding members.
- Malformed members list (e.g., spaces around commas) might cause parsing errors.
Error messages:
"Unsupported operation: channel.addMembers": Indicates the operation is not recognized; verify the resource and operation parameters.- API errors related to authentication or authorization: Check API key validity and permissions.
- Errors mentioning invalid channel or user IDs: Confirm that the channel exists and user IDs are correct.
Resolution tips:
- Ensure all required properties are correctly set.
- Validate user IDs before adding.
- Check API credentials and their permissions.
- Use the node's "Continue On Fail" option to handle errors gracefully during batch processing.