Actions32
- Account Actions
- Group Actions
- Journal Actions
- Queue Actions
- Sending Actions
- Service Actions
- Receiving Actions
Group → Remove Group Participant
AI-generatedSummary
Remove a participant from a group chat
Inputs
- chatId (required) — Unique identifier of the group chat from which the participant will be removed
- participantChatId (required) — Unique identifier of the participant within the group chat
Output shape
a JSON object indicating success, typically empty or containing an ok flag
If the participant cannot be removed, the node throws an error; otherwise the operation resolves with the API’s response
Examples
Example 1: Revoke access for a former employee from the company's group chat
Set chatId to the group’s chat ID and participantChatId to the employee’s chat ID; no other parameters are needed
Example 2: Clean up inactive members from a community group
Iterate over a list of user IDs paired with the group ID, providing each chatId and corresponding participantChatId for removal
Example 3: Handle removal gracefully when a participant may not exist
Enable continueOnFail in the workflow to suppress errors if the participant is already absent