get_group_invite_link
Destructive
Retrieve a WhatsApp group's active invite link. Optionally revoke the existing link and generate a new one, permanently invalidating all previous copies.
Instructions
Return a group's current invite link, or revoke and mint a fresh one when reset=true. Warning: reset=true permanently invalidates the previous link — anyone holding a previously-shared copy can no longer use it to join, and there is no undo. Prerequisite: admin. Use join_group_with_link to consume an invite. Returns a JSON object {link} containing the active invite URL.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"chat_jid": "<chat_jid>"
},
"name": "get_group_invite_link"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| reset | No | if true, permanently revoke the existing invite link and mint a new one (defaults to false); previously-shared copies stop working | |
| chat_jid | Yes | WhatsApp JID: individual as `<digits>@s.whatsapp.net` or bare phone digits, group as `<digits>-<timestamp>@g.us` |