Invite Info

Supported & Tested

Read invite metadata from a WhatsApp group invite code. The route is verified live. Invalid codes currently return a WhatsApp action failure, and valid codes should return invite metadata.

POSThttps://api.waplix.io/api/v1/groups/invite-info
Authentication
Authorization: Bearer YOUR_API_KEY
Parameters Specification
instance_id
stringReq

Required Waplix instance id

code
stringReq

Required invite code from chat.whatsapp.com/<code>

Usage Notes
Verified on production. Public documentation uses sanitized example data only.
Request Payload Example
Request
curl -X POST "https://api.waplix.io/api/v1/api/v1/groups/invite-info" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "instance_id": "demo_instance",
  "code": "C2Hd1q5nENFHBbxxNTpZkd"
}'
Success Response
Response · 200 OK
{
  "success": true,
  "data": {
    "instance_id": "demo_instance",
    "code": "C2Hd1q5nENFHBbxxNTpZkd",
    "invite": {
      "addressingMode": "lid",
      "subject": "Docs Manual Test Group",
      "subjectOwner": "15551234567@s.whatsapp.net",
      "subjectOwnerJid": "15551234567@s.whatsapp.net",
      "subjectTime": 1782152887,
      "size": 2,
      "creation": 1782152887,
      "owner": "15551234567@s.whatsapp.net",
      "ownerJid": "15551234567@s.whatsapp.net",
      "owner_country_code": "PK",
      "descTime": null,
      "restrict": false,
      "announce": false,
      "isCommunity": false,
      "isCommunityAnnounce": false,
      "joinApprovalMode": false,
      "memberAddMode": false,
      "participants": [
        {
          "jid": "15551234567@s.whatsapp.net",
          "lid": "15551234567@s.whatsapp.net",
          "admin": null
        },
        {
          "jid": "15551234567@s.whatsapp.net",
          "lid": "15551234567@s.whatsapp.net",
          "admin": "superadmin"
        }
      ]
    }
  }
}
Was this page helpful?