Pular para o conteúdo principal
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>"
}
'

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

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

​
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

​
instance
string
obrigatório
Nome da instância (ex.: $Instance_Name).

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.
​
Content-Type
string
obrigatório
application/json

​
Request body

​
name
string
obrigatório
Nome da comunidade. Máximo de 25 caracteres.
​
description
string
Descrição da comunidade.
​
image
string
URL ou base64. Convertida para JPEG. Falha de imagem não aborta a criação, vem reportada em imageError.
​
groupJid
string[]
Lista de JIDs @g.us de grupos existentes a vincular como subgrupos.
​
membershipApprovalMode
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

HTTPMensagem
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>
Envelope: 
{
  "success": false,
  "error": { "message": "community name is required" }
}

​
Próximo

Vincular grupos

Adicionar mais subgrupos depois da criação.

Listar subgrupos

Conferir os grupos atualmente vinculados.