Skip to main content
GET
/
communities
/
{id}
/
invite-link
Get community invite link
curl --request GET \
  --url https://api.wsapi.chat/communities/{id}/invite-link \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Instance-Id: <x-instance-id>'
{
  "link": "https://chat.whatsapp.com/abc123"
}

Authorizations

​
X-Api-Key
string
header
required

Instance or customer-level API key. Either the instance's own API key or the customer's API key is accepted. Must be paired with the X-Instance-Id header to identify the target instance.

Headers

​
X-Instance-Id
string
default:{{instanceId}}
required

The ID of the WhatsApp instance to use

Path Parameters

​
id
string
required

Community JID

Response

Invite link

​
link
string
Example:

"https://chat.whatsapp.com/abc123"