Skip to main content
POST
/
group
/
create
/
:instanceName
curl --request POST \
  --url https://api.example.com/group/create/my-instance \
  --header 'apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "subject": "Project Team",
    "participants": [
      "5511999999999",
      "5511888888888",
      "5511777777777"
    ],
    "description": "Team collaboration group",
    "promoteParticipants": false
  }'
{
  "groupJid": "[email protected]",
  "subject": "Project Team",
  "participants": [
    {
      "id": "[email protected]",
      "isAdmin": false,
      "isSuperAdmin": false
    },
    {
      "id": "[email protected]",
      "isAdmin": false,
      "isSuperAdmin": false
    },
    {
      "id": "[email protected]",
      "isAdmin": false,
      "isSuperAdmin": false
    }
  ],
  "createdAt": 1709553600
}

Overview

You can create a new WhatsApp group with a subject (name) and add initial participants. Optionally, you can set a description and automatically promote specific participants to admin status.
All phone numbers should be in international format without the ’+’ sign (e.g., 5511999999999).

Authentication

This endpoint requires authentication via the apikey header.
header.apikey
string
required
Your Evolution API key for authentication.

Path Parameters

path.instanceName
string
required
The name of your WhatsApp instance.

Request Body

subject
string
required
The name of the group (maximum 25 characters).
participants
string[]
required
Array of participant phone numbers in international format (e.g., [“5511999999999”, “5511888888888”]).
description
string
Optional group description.
promoteParticipants
boolean
default:"false"
If true, all participants will be promoted to admin status upon group creation.

Response

groupJid
string
The WhatsApp JID of the newly created group (format: [email protected]).
subject
string
The group name.
participants
array
Array of participant objects.
createdAt
number
Unix timestamp of when the group was created.
curl --request POST \
  --url https://api.example.com/group/create/my-instance \
  --header 'apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "subject": "Project Team",
    "participants": [
      "5511999999999",
      "5511888888888",
      "5511777777777"
    ],
    "description": "Team collaboration group",
    "promoteParticipants": false
  }'
{
  "groupJid": "[email protected]",
  "subject": "Project Team",
  "participants": [
    {
      "id": "[email protected]",
      "isAdmin": false,
      "isSuperAdmin": false
    },
    {
      "id": "[email protected]",
      "isAdmin": false,
      "isSuperAdmin": false
    },
    {
      "id": "[email protected]",
      "isAdmin": false,
      "isSuperAdmin": false
    }
  ],
  "createdAt": 1709553600
}

Usage Notes

WhatsApp requires at least one participant (besides the creator) to create a group.
Invalid phone numbers or numbers not registered on WhatsApp will be silently skipped during group creation.
The instance owner is automatically added as the group creator and super admin.

Build docs developers (and LLMs) love