Skip to main content
Join a WhatsApp group using an invitation link.
Make sure you have permission to join the group. Some groups may require admin approval before you can join.

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.
The WhatsApp group invitation linkExample: https://chat.whatsapp.com/whatsappKeyJoinGroup

Response

code
string
Response code (e.g., SUCCESS)
message
string
Response message describing the resultExample: Success
results
string
Additional result data (typically null for this endpoint)
curl -X POST \
  'https://your-api-domain.com/group/join-with-link' \
  -H 'Content-Type: application/json' \
  -H 'X-Device-Id: my-device' \
  -u 'username:password' \
  -d '{
    "link": "https://chat.whatsapp.com/whatsappKeyJoinGroup"
  }'
{
  "code": "SUCCESS",
  "message": "Success",
  "results": null
}

Build docs developers (and LLMs) love