Pular para o conteúdo principal
POST
/
api
/
community
/
link
/
:instance
Vincular grupos
curl --request POST \
  --url https://api.example.com/api/community/link/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "communityJid": "<string>",
  "groupJid": [
    "<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

Vincula um ou mais grupos existentes a uma comunidade. Cada vinculação tem delay interno de 1s para evitar throttling do servidor WhatsApp. Falhas individuais não abortam a operação, vão para o array failed.

​
Exemplos

​
Vincular 2 grupos

Anexa em lote 2 grupos existentes à comunidade 120363406289005073@g.us numa única chamada. O serviço aplica delay interno de 1s entre as vinculações para evitar throttling. 
curl -X POST "https://ryzeapi.cloud/api/community/link/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "communityJid": "120363406289005073@g.us",
    "groupJid": [
      "120363406289005074@g.us",
      "120363406289005075@g.us"
    ]
  }'

​
Vincular 1 grupo

Vincula um único grupo à comunidade. O array groupJid aceita 1 ou mais itens, útil quando você quer adicionar subgrupos um a um. 
curl -X POST "https://ryzeapi.cloud/api/community/link/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "communityJid": "120363406289005073@g.us",
    "groupJid": ["120363406289005074@g.us"]
  }'

​
Resposta de sucesso

Devolve a contagem em message (formato "Linked N of M groups to community"), o array linked com os JIDs vinculados com sucesso e failed com os que não foram processados (JID inválido, grupo já vinculado a outra comunidade ou bot sem permissão). success é true quando ao menos um grupo foi vinculado.
200 OK
{
  "success": true,
  "message": "Linked 2 of 2 groups to community",
  "linked": [
    "120363406289005074@g.us",
    "120363406289005075@g.us"
  ],
  "failed": []
}
Sucesso parcial e falha total retornam HTTP 200. Sempre cheque success + failed[] no cliente para detectar erros por grupo.

​
Parâmetros de rota

​
instance
string
obrigatório
Nome da instância.

​
Headers

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

​
Request body

​
communityJid
string
obrigatório
JID @g.us da comunidade.
​
groupJid
string[]
obrigatório
Array de JIDs @g.us dos grupos a vincular. Pelo menos 1 item.

​
Notas

  • Grupo já vinculado a outra comunidade cai em failed[], desvincule antes via /unlink.
  • Limite de 50 subgrupos por comunidade. Excedentes falham silenciosamente.
  • O Grupo de Anúncios já pertence à comunidade desde a criação e não pode ser vinculado.
  • Bot precisa ser admin tanto da comunidade quanto do grupo sendo vinculado.

​
Erros

HTTPMensagem
400community jid is required
400group jid is required
400Instance is not connected to WhatsApp
500error parse community jid: <reason>
Envelope: 
{
  "success": false,
  "error": { "message": "community jid is required" }
}

​
Próximo

Desvincular grupos

Remover grupos da comunidade.

Listar subgrupos

Confirmar os subgrupos vinculados.