Skip to main content
GET
/
api
/
{session}
/
groups
/
{id}
/
invite-code
Get the invite code for the group
curl --request GET \
  --url https://{host}/api/{session}/groups/{id}/invite-code \
  --header 'apikey: <api-key>'
{
  "code": "Abc123Xyz456"
}

Documentation Index

Fetch the complete documentation index at: https://docs.wappfy.com.br/llms.txt

Use this file to discover all available pages before exploring further.

​
Description

This endpoint returns the invite code of a group, which can be used to add new members.

​
URL Parameters

​
session
string
required
WhatsApp unique session ID
​
id
string
required
Group ID in format 120363XXXXX@g.us

​
Response

​
code
string
Group invite code
{
  "code": "Abc123Xyz456"
}

​
Status Codes

  • 200 - Code returned successfully
  • 400 - Invalid parameters
  • 401 - Unauthorized
  • 403 - No permission (admins only)
  • 404 - Group not found

​
Usage Example

curl -X GET https://api.wappfy.com.br/api/my-session/groups/120363XXXXX@g.us/invite-code

Authorizations

​
apikey
string
header
required

Your Wappfy API key (get it at dash.wappfy.com.br)

Path Parameters

​
id
string
required

ID do Grupo

Response

200 - application/json

The response is of type string.