Create Group

POST

api

group

create

:instance

Create Group

curl --request POST \
  --url https://api.example.com/api/group/create/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "name": "<string>",
  "participants": [
    "<string>"
  ],
  "description": "<string>",
  "image": "<string>",
  "communityJid": "<string>",
  "groupSettings": {}
}
'

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    name: '<string>',
    participants: ['<string>'],
    description: '<string>',
    image: '<string>',
    communityJid: '<string>',
    groupSettings: {}
  })
};

fetch('https://api.example.com/api/group/create/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/group/create/:instance"

payload = {
    "name": "<string>",
    "participants": ["<string>"],
    "description": "<string>",
    "image": "<string>",
    "communityJid": "<string>",
    "groupSettings": {}
}
headers = {
    "token": "<token>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Auth: TokenAccount or TokenInstance • Rate-limit: Global (100/min) • Idempotent: no

Description

Creates a WhatsApp group and optionally links it to an existing community (communityJid). You can set the name, description, picture, and initial permissions (groupSettings) in the same call. The picture and description are applied in subsequent calls after the group is created.

Examples

Minimum

Creates a “Dev Team” group with 2 initial participants (5511999999999, 5521988888888), with no description, picture, community, or custom permissions.

curl -X POST "https://ryzeapi.cloud/api/group/create/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Dev Team",
    "participants": ["5511999999999", "5521988888888"]
  }'

await fetch(`https://ryzeapi.cloud/api/group/create/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    name:         "Dev Team",
    participants: ["5511999999999", "5521988888888"]
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/group/create/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "name":         "Dev Team",
        "participants": ["5511999999999", "5521988888888"]
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "name": "Dev Team",
        "participants": ["5511999999999", "5521988888888"]
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/group/create/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

With description and picture

Creates the group with the description “Technical discussions” and a picture from a public URL. Description and image are applied in subsequent calls after the group is created.

curl -X POST "https://ryzeapi.cloud/api/group/create/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Dev Team",
    "description": "Technical discussions",
    "image": "https://example.com/logo.png",
    "participants": ["5511999999999", "5521988888888"]
  }'

await fetch(`https://ryzeapi.cloud/api/group/create/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    name:         "Dev Team",
    description:  "Technical discussions",
    image:        "https://example.com/logo.png",
    participants: ["5511999999999", "5521988888888"]
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/group/create/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "name":         "Dev Team",
        "description":  "Technical discussions",
        "image":        "https://example.com/logo.png",
        "participants": ["5511999999999", "5521988888888"]
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "name": "Dev Team",
        "description": "Technical discussions",
        "image": "https://example.com/logo.png",
        "participants": ["5511999999999", "5521988888888"]
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/group/create/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

With permissions

Creates an “Announcements” group with initial restrictions: only admins can send messages (membersCanSendMessages: false) and new joins require approval (requireAdminApproval: true).

curl -X POST "https://ryzeapi.cloud/api/group/create/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Announcements",
    "participants": ["5511999999999"],
    "groupSettings": {
      "membersCanSendMessages": false,
      "requireAdminApproval": true
    }
  }'

await fetch(`https://ryzeapi.cloud/api/group/create/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    name:         "Announcements",
    participants: ["5511999999999"],
    groupSettings: {
      membersCanSendMessages: false,
      requireAdminApproval:   true
    }
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/group/create/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "name":         "Announcements",
        "participants": ["5511999999999"],
        "groupSettings": {
            "membersCanSendMessages": False,
            "requireAdminApproval":   True
        }
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "name": "Announcements",
        "participants": ["5511999999999"],
        "groupSettings": {
            "membersCanSendMessages": false,
            "requireAdminApproval": true
        }
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/group/create/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Linked to a community

Creates the “General Subgroup” already linked to the community 120363406289005073@g.us via communityJid, avoiding the extra step of calling /community/link after creation.

curl -X POST "https://ryzeapi.cloud/api/group/create/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "General Subgroup",
    "participants": ["5511999999999"],
    "communityJid": "120363406289005073@g.us"
  }'

await fetch(`https://ryzeapi.cloud/api/group/create/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    name:         "General Subgroup",
    participants: ["5511999999999"],
    communityJid: "120363406289005073@g.us"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/group/create/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "name":         "General Subgroup",
        "participants": ["5511999999999"],
        "communityJid": "120363406289005073@g.us"
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "name": "General Subgroup",
        "participants": ["5511999999999"],
        "communityJid": "120363406289005073@g.us"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/group/create/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Success response

The response includes the freshly created group.jid (use it as the identifier in subsequent calls), the inviteCode and inviteLink ready to share, and the participants list already flagged with isAdmin/isSuperAdmin. The creator joins automatically as super-admin. The groupSettings fields reflect the initial permissions (defaults or whatever you sent).

200 OK

{
  "success": true,
  "message": "Group created successfully",
  "group": {
    "name": "Dev Team",
    "jid": "120363406289005073@g.us",
    "description": "Technical discussions",
    "inviteCode": "ABC123XYZ",
    "inviteLink": "https://chat.whatsapp.com/ABC123XYZ",
    "createdBy": "5511999999999@s.whatsapp.net",
    "participantCount": 3,
    "participants": [
      { "jid": "5511999999999@s.whatsapp.net", "isAdmin": true, "isSuperAdmin": false }
    ],
    "groupSettings": {
      "membersCanEditInfo": true,
      "membersCanSendMessages": true,
      "membersCanAddOthers": false,
      "requireAdminApproval": false
    },
    "isCommunity": false,
    "isParent": false,
    "linkedParentJid": null
  }
}

Path parameters

string

required

Instance name (e.g., $Instance_Name).

Headers

string

required

TokenAccount or TokenInstance.

string

required

application/json

Request body

string

required

Group name. Max 25 characters.

string[]

required

List of numbers (5511999999999) or JIDs (5511999999999@s.whatsapp.net). At least 1 item.

string

Group description (topic). Applied via SetGroupTopic after creation.

string

Public URL or base64 data URI. The image is converted to JPEG.

string

Creates the group already linked to a community (parent group).

object

Initial permissions. Subfields: membersCanEditInfo, membersCanSendMessages, membersCanAddOthers, requireAdminApproval.

Notes

The group creator joins automatically as super-admin.
Invalid numbers (not registered on WhatsApp) are rejected; the error indicates which participant failed.
If image is provided and the upload fails, group creation continues normally, the image error is not fatal on this route. Use PUT /update to reapply the picture.

Errors

HTTP	Message
400	`The 'name' field is required`
400	`At least one participant is required`
400	`group name must be 25 characters or less`
400	`invalid participant <number>: <reason>`
400	`Instance is not connected to WhatsApp`
429	`rate limit exceeded (429): wait before creating again`

Envelope:

{
  "success": false,
  "error": { "message": "The 'name' field is required" }
}

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Description

Examples

Minimum

With description and picture

With permissions

Linked to a community

Success response

Path parameters

Headers

Request body

Notes

Errors

​Description

​Examples

​Minimum

​With description and picture

​With permissions

​Linked to a community

​Success response

​Path parameters

​Headers

​Request body

​Notes

​Errors

Description

Examples

Minimum

With description and picture

With permissions

Linked to a community

Success response

Path parameters

Headers

Request body

Notes

Errors