Skip to main content
POST
/
api
/
instances
/
{instanceId}
/
groups
/
join
Join a group via invite code
curl --request POST \
  --url https://api.wappfy.io/api/instances/{instanceId}/groups/join \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>"
}
'
{
  "id": "[email protected]",
  "subject": "Team Chat",
  "participants": [
    {
      "id": "[email protected]",
      "admin": "admin"
    }
  ],
  "creation": 1707350400,
  "description": "<string>",
  "pictureUrl": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

instanceId
string<uuid>
required

The WhatsApp instance UUID

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Body

application/json
code
string
required

Group invite code or full invite link

Response

Joined the group

id
string
required

Group JID

subject
string
required

Group subject/title

Example:

"Team Chat"

participants
object[]
required

Group members

creation
number
required

Creation timestamp

Example:

1707350400

description
string

Group description text

pictureUrl
string

Group picture URL