Skip to main content
POST
/
api
/
instances
/
{instanceId}
/
groups
Create a group
curl --request POST \
  --url https://api.wappfy.io/api/instances/{instanceId}/groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Group",
  "participants": [
    "5581999999999@c.us"
  ]
}
'
{
  "id": "120363XXX@g.us",
  "subject": "Team Chat",
  "participants": [
    {
      "id": "5511999999999@c.us"
    }
  ],
  "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
​
name
string
required
Example:

"My Group"

​
participants
string[]
required
Example:
["5581999999999@c.us"]

Response

Group created

​
id
string
required

Group JID

Example:

"120363XXX@g.us"

​
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