Overview

This node operation removes participants from a specified group in a messaging or collaboration platform. It is useful for managing group memberships by programmatically removing users from groups based on their IDs. For example, it can be used to automate the cleanup of inactive members or to enforce group membership policies.

Use Case Examples

1. Remove specific users from a group by providing their participant IDs.
2. Automate group management by removing participants based on certain criteria or events.

Properties

Output

JSON

• success - Indicates whether the participants were successfully removed from the group.
• removedParticipants - Details of the participants that were removed from the group.
• groupId - The ID of the group from which participants were removed.

Dependencies

• Requires an active session identified by the session name to authenticate and authorize the operation.

Troubleshooting

• Ensure the session name is valid and active; otherwise, the operation will fail due to authentication errors.
• Verify that the group ID is correct and that the group exists; invalid group IDs will cause errors.
• Participants must be specified in the correct JSON format; malformed JSON will cause parsing errors.
• If batching is enabled, ensure batch size and interval are set appropriately to avoid request throttling or timeouts.
• If SSL certificate validation is disabled, be aware of potential security risks.
• Proxy settings must be correctly configured if used, including authentication if required.