Overview

This node operation revokes an invite code for a specified group in a messaging or social platform. It is useful for administrators or moderators who want to invalidate an existing invite link to control group membership and enhance security. For example, if an invite code has been shared publicly and unauthorized users are joining, this operation can revoke that code to prevent further access.

Use Case Examples

1. Revoke an invite code for a group to stop new members from joining using that code.
2. Manage group membership by invalidating old or compromised invite codes.

Properties

Output

JSON

• success - Indicates whether the invite code revocation was successful.
• message - Additional information or confirmation message about the revocation operation.

Dependencies

• Requires an authenticated session to interact with the group management API.

Troubleshooting

• Ensure the session name is valid and authenticated; otherwise, the operation will fail due to authorization errors.
• Verify the group ID is correct and the user has permission to revoke invite codes for that group.
• If using a proxy or custom request options, confirm the settings are correct to avoid connection issues.
• Timeout errors may occur if the server is slow or unresponsive; increase the timeout setting if needed.