Criar comunidade

POST

api

community

create

:instance

Criar comunidade

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

Descrição

Cria uma comunidade (grupo-pai com Grupo de Anúncios automático). Aceita opcionalmente descrição, foto e uma lista de grupos existentes a vincular durante a criação. Cada vinculação tem delay de 1s entre chamadas para evitar throttling do servidor WhatsApp.

Se o servidor WhatsApp rejeitar a criação como parent (400), o serviço faz fallback automático para grupo regular. A resposta vem com isCommunity: false na resposta e um aviso na message.

Exemplos

Mínimo

Cria a comunidade apenas com o name obrigatório (“Comunidade Alpha”), sem descrição, foto nem subgrupos vinculados na chamada.

curl -X POST "https://ryzeapi.cloud/api/community/create/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Comunidade Alpha"
  }'

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: "Comunidade Alpha"
  })
});

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": "Comunidade Alpha"
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "name": "Comunidade Alpha"
    }`)
    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)
}

Com subgrupos

Cria a comunidade “Empresa XYZ” com descrição, foto e já vincula 2 grupos existentes (groupJid) como subgrupos, além de definir membershipApprovalMode: request_required para que entradas precisem de aprovação.

curl -X POST "https://ryzeapi.cloud/api/community/create/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Empresa XYZ",
    "description": "Comunidade oficial",
    "image": "https://exemplo.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:        "Empresa XYZ",
    description: "Comunidade oficial",
    image:       "https://exemplo.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":        "Empresa XYZ",
        "description": "Comunidade oficial",
        "image":       "https://exemplo.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": "Empresa XYZ",
        "description": "Comunidade oficial",
        "image": "https://exemplo.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)
}

Resposta de sucesso

Devolve a comunidade recém-criada em group, onde group.jid é o JID da comunidade (use-o como communityJid em chamadas subsequentes) e isCommunity: true confirma que o WhatsApp aceitou a criação como parent group. Os grupos passados em groupJid são processados em ordem e separados em linkedGroups (sucesso) e failedGroups (falha). Se uma image foi enviada mas falhou ao aplicar, o motivo aparece em imageError sem abortar a criação.

200 OK

{
  "success": true,
  "message": "Community created successfully",
  "linkedGroups": ["120363406289005074@g.us"],
  "failedGroups": [],
  "imageError": "",
  "group": {
    "name": "Comunidade Alpha",
    "jid": "120363406289005073@g.us",
    "description": "Comunidade oficial",
    "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 rota

string

obrigatório

Nome da instância (ex.: $Instance_Name).

Headers

string

obrigatório

TokenAccount ou TokenInstance.

string

obrigatório

application/json

Request body

string

obrigatório

Nome da comunidade. Máximo de 25 caracteres.

string

Descrição da comunidade.

string

URL ou base64. Convertida para JPEG. Falha de imagem não aborta a criação, vem reportada em imageError.

string[]

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

string

request_required (subgrupos exigem aprovação por default) ou string vazia (open).

Notas

A comunidade nasce sem participantes, membros entram via cada subgrupo.
O Grupo de Anúncios é criado automaticamente pelo WhatsApp. Você não controla nome / descrição dele aqui, use PUT /api/group/update depois para ajustar.
Limite de 50 subgrupos por comunidade (excedentes caem em failedGroups).
imageError é populado quando a foto falha mas a comunidade é criada normalmente.
Fallback silencioso para grupo regular: monitore isCommunity no cliente para alertar o usuário.

Erros

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

Envelope:

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

Vincular grupos

Adicionar mais subgrupos depois da criação.

Listar subgrupos

Conferir os grupos atualmente vinculados.

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Criar comunidade

Descrição

Exemplos

Mínimo

Com subgrupos

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Notas

Erros

Próximo

Vincular grupos

Listar subgrupos

​Descrição

​Exemplos

​Mínimo

​Com subgrupos

​Resposta de sucesso

​Parâmetros de rota

​Headers

​Request body

​Notas

​Erros

​Próximo

Vincular grupos

Listar subgrupos

Descrição

Exemplos

Mínimo

Com subgrupos

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Notas

Erros

Próximo