Skip to main content
POST
/
api
/
{session}
/
groups
/
join
Join group via code
curl --request POST \
  --url https://{host}/api/{session}/groups/join \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '{
  "code": "https://chat.whatsapp.com/1234567890abcdef"
}'
{
  "success": true,
  "groupId": "120363XXXXX@g.us",
  "message": "You joined the group successfully"
}

​
Description

This endpoint allows joining a group using an invite code.

​
URL Parameters

​
session
string
required
WhatsApp unique session ID

​
Body

{
  "code": "value"
}

​
Body Parameters

PropertyTypeRequiredDescription
codestring✅ YesGroup invite code

​
Response

{
  "success": true,
  "groupId": "120363XXXXX@g.us",
  "message": "You joined the group successfully"
}

​
Status Codes

  • 200 - Joined successfully
  • 400 - Invalid code
  • 401 - Unauthorized
  • 404 - Group not found

​
Usage Example

curl -X POST https://api.wappfy.com.br/api/my-session/groups/join \
  -H "Content-Type: application/json" \
  -d '{
    "code": "Abc123Xyz456"
  }'

Authorizations

​
apikey
string
header
required

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

Path Parameters

​
session
string
required

Session name (instanceName)

Body

application/json
​
code
string
required

Group code (123) or url (https://chat.whatsapp.com/123)

Example:

"https://chat.whatsapp.com/1234567890abcdef"

Response

200 - application/json
​
id
string
required

ID do Grupo

Example:

"123@g.us"

⌘I