Skip to main content
POST
/
api
/
{session}
/
groups
Create a new group
curl --request POST \
  --url https://{host}/api/{session}/groups \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "name": "My Group",
  "participants": [
    {
      "id": "123456789@c.us"
    }
  ]
}
'
{
  "id": "120363XXXXX@g.us",
  "subject": "My New Group",
  "creation": 1234567890
}

​
Description

This endpoint allows you to create a new group on WhatsApp with a name and list of participants specified.

​
URL Parameters

​
session
string
required
WhatsApp unique session ID

​
Body

{
  "name": "My Group",
  "participants": [
    "5511999999999@s.whatsapp.net"
  ]
}

​
Body Parameters

PropertyTypeRequiredDescription
namestring✅ YesName of the group to be created
participantsarray✅ YesArray of participant JIDs of the group. Format: ["5511999999999@s.whatsapp.net", "5511888888888@s.whatsapp.net"]

​
Response

​
id
string
ID of the group created in format 120363XXXXX@g.us
{
  "id": "120363XXXXX@g.us",
  "subject": "My New Group",
  "creation": 1234567890
}

​
Status Codes

  • 200 - Group created successfully
  • 400 - Invalid parameters
  • 401 - Unauthorized

​
Usage Example

curl -X POST https://api.wappfy.com.br/api/my-session/groups \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My New Group",
    "participants": ["5511999999999@s.whatsapp.net", "5511888888888@s.whatsapp.net"]
  }'

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
​
name
string
required

Group name

Example:

"My Group"

​
participants
object[]
required

Array of group participants

Response

201 - undefined