Crear comunidad

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

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

fetch('https://api.example.com/api/community/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/community/create/:instance"

payload = {
    "name": "<string>",
    "description": "<string>",
    "image": "<string>",
    "groupJid": ["<string>"],
    "membershipApprovalMode": "<string>"
}
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 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"
  }'

await fetch(`https://ryzeapi.cloud/api/community/create/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    name: "Alpha Community"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/community/create/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "name": "Alpha Community"
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "name": "Alpha Community"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/community/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 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"
  }'

await fetch(`https://ryzeapi.cloud/api/community/create/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    name:        "XYZ Company",
    description: "Official community",
    image:       "https://example.com/community.png",
    groupJid: [
      "120363406289005074@g.us",
      "120363406289005075@g.us"
    ],
    membershipApprovalMode: "request_required"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/community/create/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "name":        "XYZ Company",
        "description": "Official community",
        "image":       "https://example.com/community.png",
        "groupJid": [
            "120363406289005074@g.us",
            "120363406289005075@g.us"
        ],
        "membershipApprovalMode": "request_required"
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "name": "XYZ Company",
        "description": "Official community",
        "image": "https://example.com/community.png",
        "groupJid": [
            "120363406289005074@g.us",
            "120363406289005075@g.us"
        ],
        "membershipApprovalMode": "request_required"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/community/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

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

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 de la comunidad. Máximo 25 caracteres.

string

Descripción de la comunidad.

string

URL o base64. Convertida a JPEG. Un fallo de imagen no aborta la creación, se reporta en imageError.

string[]

Lista de JIDs @g.us de grupos existentes para vincular como subgrupos.

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

HTTP	Mensaje
400	`community name is required`
400	`Community name must be 25 characters or less`
400	`Instance is not connected to WhatsApp`
429	`rate limit exceeded (429): wait before creating again`
500	`failed to create community: <reason>`

Envoltorio:

{
  "success": false,
  "error": { "message": "community name is required" }
}

Vincular grupos

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

Listar subgrupos

Verifica los grupos vinculados actualmente.

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Crear comunidad

Descripción

Ejemplos

Mínimo

Con subgrupos

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Notas

Errores

Siguiente

Vincular grupos

Listar subgrupos

​Descripción

​Ejemplos

​Mínimo

​Con subgrupos

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Cuerpo de la solicitud

​Notas

​Errores

​Siguiente

Vincular grupos

Listar subgrupos

Descripción

Ejemplos

Mínimo

Con subgrupos

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Notas

Errores

Siguiente