Actions101
- š¤ Chatting Actions
- š„ļø Sessions Actions
- š Auth Actions
- š¼ļø Screenshot Actions
- š¢ Channels Actions
- š¢ Status Actions
- š¬ Chats Actions
- š¤ Contacts Actions
- š„ Groups Actions
- ā Presence Actions
- š·ļø Labels Actions
- š Observability Actions
Overview
This node operation removes participants from a specified group in a messaging platform. It is useful for managing group memberships by programmatically removing users from groups based on their IDs. For example, it can be used in automated workflows to clean up group participants or enforce group membership policies.
Use Case Examples
- Removing a list of users from a group chat by specifying their participant IDs.
- Automating group management by removing inactive or unauthorized participants from a group.
Properties
| Name | Meaning |
|---|---|
| Session | The session name used to identify the messaging session. |
| Id | The unique identifier of the group from which participants will be removed. |
| Participants | A JSON array of participant objects, each containing an 'id' field representing the participant's unique identifier to be removed from the group. |
| Request Options | Optional settings for the request such as batching, SSL certificate validation, proxy configuration, and timeout settings. |
Output
JSON
success- Indicates whether the participants were successfully removed from the group.removedParticipants- List of participant IDs that were removed from the group.groupId- The ID of the group from which participants were removed.
Dependencies
- Requires an active messaging session identified by the session name.
- May require API authentication credentials for the messaging platform.
Troubleshooting
- Ensure the session name is correct and active; otherwise, the node cannot connect to the messaging platform.
- Verify that the group ID is valid and that the user or bot has permission to remove participants from the group.
- Check the format of the participants JSON array; it must be correctly formatted with valid participant IDs.
- If batching is enabled, ensure batch size and interval are set appropriately to avoid request throttling or timeouts.
- If SSL issues occur, consider enabling the 'Ignore SSL Issues' option, but be aware of security risks.
- Proxy settings must be correct if used; incorrect proxy configuration can cause request failures.
- Timeouts may occur if the server is slow or unresponsive; increase the timeout setting if necessary.