Saltar al contenido principal
POST
/
api
/
community
/
create
/
:instance
Crear comunidad
curl --request POST \
  --url https://api.example.com/api/community/create/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "image": "<string>",
  "groupJid": [
    "<string>"
  ],
  "membershipApprovalMode": "<string>"
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Auth: TokenAccount o TokenInstance • Rate-limit: Global (100/min) • Idempotente: no

​
Descripción

Crea una comunidad (grupo padre con un Grupo de Anuncios automático). Acepta opcionalmente una descripción, una imagen y una lista de grupos existentes para vincular durante la creación. Cada vinculación tiene un delay de 1s entre llamadas para evitar throttling del servidor de WhatsApp.
Si el servidor de WhatsApp rechaza la creación como padre (400), el servicio realiza un fallback automático a un grupo regular. La respuesta vuelve con isCommunity: false y un aviso en message.

​
Ejemplos

​
Mínimo

Crea la comunidad solo con el name requerido (“Alpha Community”), sin descripción, imagen ni subgrupos vinculados en la llamada. 
curl -X POST "https://ryzeapi.cloud/api/community/create/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Alpha Community"
  }'

​
Con subgrupos

Crea la comunidad “XYZ Company” con descripción, imagen y vincula 2 grupos existentes (groupJid) como subgrupos, además de fijar membershipApprovalMode: request_required para que las uniones requieran aprobación. 
curl -X POST "https://ryzeapi.cloud/api/community/create/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "XYZ Company",
    "description": "Official community",
    "image": "https://example.com/community.png",
    "groupJid": [
      "120363406289005074@g.us",
      "120363406289005075@g.us"
    ],
    "membershipApprovalMode": "request_required"
  }'

​
Respuesta exitosa

Devuelve la comunidad recién creada en group, donde group.jid es el JID de la comunidad (úsalo como communityJid en llamadas posteriores) e isCommunity: true confirma que WhatsApp aceptó la creación como grupo padre. Los grupos pasados en groupJid se procesan en orden y se separan en linkedGroups (éxito) y failedGroups (fallo). Si se envió una image pero falló al aplicarse, la razón aparece en imageError sin abortar la creación.
200 OK
{
  "success": true,
  "message": "Community created successfully",
  "linkedGroups": ["120363406289005074@g.us"],
  "failedGroups": [],
  "imageError": "",
  "group": {
    "name": "Alpha Community",
    "jid": "120363406289005073@g.us",
    "description": "Official community",
    "inviteCode": "ABC123XYZ",
    "inviteLink": "https://chat.whatsapp.com/ABC123XYZ",
    "createdBy": "5511999999999@s.whatsapp.net",
    "participantCount": 1,
    "participants": [
      { "jid": "5511999999999@s.whatsapp.net", "isAdmin": true, "isSuperAdmin": true }
    ],
    "isCommunity": true,
    "isParent": true
  }
}

​
Parámetros de ruta

​
instance
string
requerido
Nombre de la instancia (por ejemplo, $Instance_Name).

​
Cabeceras

​
token
string
requerido
TokenAccount o TokenInstance.
​
Content-Type
string
requerido
application/json

​
Cuerpo de la solicitud

​
name
string
requerido
Nombre de la comunidad. Máximo 25 caracteres.
​
description
string
Descripción de la comunidad.
​
image
string
URL o base64. Convertida a JPEG. Un fallo de imagen no aborta la creación, se reporta en imageError.
​
groupJid
string[]
Lista de JIDs @g.us de grupos existentes para vincular como subgrupos.
​
membershipApprovalMode
string
request_required (los subgrupos requieren aprobación por defecto) o cadena vacía (abierto).

​
Notas

  • La comunidad nace sin participantes, los miembros se unen mediante cada subgrupo.
  • El Grupo de Anuncios lo crea automáticamente WhatsApp. No controlas su nombre / descripción aquí, usa PUT /api/group/update después para ajustarlo.
  • Límite de 50 subgrupos por comunidad (los excedentes terminan en failedGroups).
  • imageError se completa cuando la imagen falla pero la comunidad se crea normalmente.
  • Fallback silencioso a grupo regular: monitorea isCommunity del lado del cliente para alertar al usuario.

​
Errores

HTTPMensaje
400community name is required
400Community name must be 25 characters or less
400Instance is not connected to WhatsApp
429rate limit exceeded (429): wait before creating again
500failed to create community: <reason>
Envoltorio: 
{
  "success": false,
  "error": { "message": "community name is required" }
}

​
Siguiente

Vincular grupos

Agrega más subgrupos después de la creación.

Listar subgrupos

Verifica los grupos vinculados actualmente.