Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
group-invitation-link
/
{groupId}
Get invitation link
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/group-invitation-link/{groupId} \
  --header 'Client-Token: <api-key>'
{
  "phone": "<string>",
  "invitationLink": "<string>"
}

​
Overview

This method allows you to get a group’s invitation link.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Path

​
groupId
string
required
Group ID/Phone

​
Response

​
200

​
phone
string
Group ID/Phone
​
invitationLink
string
Group invitation link
{
  "phone": "120363019502650977-group",
  "invitationLink": "https://chat.whatsapp.com/C1adgkdEGki7554BWDdMkd"
}

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.