Skip to main content
Retrieve or reset the invitation link for a WhatsApp group. Only group admins can perform this operation.
Resetting the invite link will invalidate the previous link, preventing anyone with the old link from joining the group.

​
Request

​
X-Device-Id
string
Device identifier for multi-device support. Required when multiple devices are registered. If only one device is registered, it will be used as the default.
​
group_id
string
required
The WhatsApp group ID to get the invite link forExample: [email protected]
​
reset
boolean
default:"false"
Whether to reset (revoke) the existing invite link and generate a new oneExample: false

​
Response

​
code
string
Response code (e.g., SUCCESS)
​
message
string
Response message describing the resultExample: Success get group invite link
​
results
object
​
invite_link
string
The group invitation link that can be sharedExample: https://chat.whatsapp.com/ABC123...
​
group_id
string
The group IDExample: [email protected]
curl -X GET \
  'https://your-api-domain.com/group/[email protected]&reset=false' \
  -H 'X-Device-Id: my-device' \
  -u 'username:password'

{
  "code": "SUCCESS",
  "message": "Success get group invite link",
  "results": {
    "invite_link": "https://chat.whatsapp.com/ABC123DEF456GHI789",
    "group_id": "[email protected]"
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us