Crear grupo

POST

api

group

create

:instance

Crear grupo

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 o TokenInstance • Rate-limit: Global (100/min) • Idempotente: no

Descripción

Crea un grupo de WhatsApp y opcionalmente lo vincula a una comunidad existente (communityJid). Puedes establecer el nombre, la descripción, la imagen y los permisos iniciales (groupSettings) en la misma llamada. La imagen y la descripción se aplican en llamadas posteriores luego de que se crea el grupo.

Ejemplos

Mínimo

Crea un grupo “Dev Team” con 2 participantes iniciales (5511999999999, 5521988888888), sin descripción, imagen, comunidad ni permisos personalizados.

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)
}

Con descripción e imagen

Crea el grupo con la descripción “Technical discussions” y una imagen desde una URL pública. La descripción y la imagen se aplican en llamadas posteriores luego de la creación del grupo.

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)
}

Con permisos

Crea un grupo “Announcements” con restricciones iniciales: solo los administradores pueden enviar mensajes (membersCanSendMessages: false) y las nuevas uniones requieren aprobación (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)
}

Vinculado a una comunidad

Crea el “General Subgroup” ya vinculado a la comunidad 120363406289005073@g.us mediante communityJid, evitando el paso adicional de llamar a /community/link después de la creación.

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)
}

Respuesta exitosa

La respuesta incluye el group.jid recién creado (úsalo como identifier en llamadas posteriores), el inviteCode y inviteLink listos para compartir, y la lista de participants ya marcada con isAdmin/isSuperAdmin. El creador se une automáticamente como super-admin. Los campos groupSettings reflejan los permisos iniciales (predeterminados o lo que hayas enviado).

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
  }
}

Parámetros de ruta

string

requerido

Nombre de la instancia (por ejemplo, $Instance_Name).

Cabeceras

string

requerido

TokenAccount o TokenInstance.

string

requerido

application/json

Cuerpo de la solicitud

string

requerido

Nombre del grupo. Máximo 25 caracteres.

string[]

requerido

Lista de números (5511999999999) o JIDs (5511999999999@s.whatsapp.net). Al menos 1 elemento.

string

Descripción del grupo (topic). Aplicada vía SetGroupTopic después de la creación.

string

URL pública o data URI base64. La imagen se convierte a JPEG.

string

Crea el grupo ya vinculado a una comunidad (grupo padre).

object

Permisos iniciales. Subcampos: membersCanEditInfo, membersCanSendMessages, membersCanAddOthers, requireAdminApproval.

Notas

El creador del grupo se une automáticamente como super-admin.
Los números inválidos (no registrados en WhatsApp) son rechazados; el error indica qué participante falló.
Si se proporciona image y la subida falla, la creación del grupo continúa normalmente, el error de imagen no es fatal en esta ruta. Usa PUT /update para reaplicar la imagen.

Errores

HTTP	Mensaje
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`

Envoltorio:

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

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Descripción

Ejemplos

Mínimo

Con descripción e imagen

Con permisos

Vinculado a una comunidad

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Notas

Errores

​Descripción

​Ejemplos

​Mínimo

​Con descripción e imagen

​Con permisos

​Vinculado a una comunidad

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Cuerpo de la solicitud

​Notas

​Errores

Descripción

Ejemplos

Mínimo

Con descripción e imagen

Con permisos

Vinculado a una comunidad

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Notas

Errores