Skip to main content
POST
/
group
/
create
/
{instanceName}
Create Group
curl --request POST \
  --url https://api.flowmod.ai/group/create/{instanceName} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "subject": "My New Group",
  "participants": [
    "5511999999999",
    "5511888888888"
  ],
  "description": "This is a test group",
  "promoteParticipants": false
}
'
{
  "status": 201,
  "error": false,
  "response": {
    "id": "<string>",
    "subject": "<string>",
    "owner": "<string>",
    "participants": [
      {
        "id": "<string>",
        "admin": "superadmin"
      }
    ],
    "desc": "<string>",
    "creation": 123,
    "size": 123
  }
}

Authorizations

apikey
string
header
required

Organization-specific API key for Evolution API access

Path Parameters

instanceName
string
required

Body

application/json
subject
string
required

Group name/subject

Example:

"My New Group"

participants
string[]
required

Array of phone numbers to add as participants

Example:
["5511999999999", "5511888888888"]
description
string

Group description

Example:

"This is a test group"

promoteParticipants
boolean
default:false

Whether to promote participants to admin

Response

200 - application/json

Group created successfully

status
number
Example:

201

error
boolean
Example:

false

response
object