Pular para o conteúdo principal
POST
/
api
/
community
/
unlink
/
:instance
Desvincular grupos
curl --request POST \
  --url https://api.example.com/api/community/unlink/: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

Desvincula grupos de uma comunidade. Os grupos não são deletados, apenas voltam a ser independentes (sem linkedParentJid). Mesmo body e response do /link (DTO compartilhado).
O campo linked na resposta contém os JIDs desvinculados com sucesso (devido ao reuso do DTO CommunityLinkResponse). A message ("Unlinked N of M ...") confirma a semântica.

​
Exemplos

​
Desvincular grupos

Remove 2 subgrupos da comunidade 120363406289005073@g.us. Os grupos voltam a ser independentes (sem linkedParentJid) mas continuam existindo com seus membros. 
curl -X POST "https://ryzeapi.cloud/api/community/unlink/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "communityJid": "120363406289005073@g.us",
    "groupJid": [
      "120363406289005074@g.us",
      "120363406289005075@g.us"
    ]
  }'

​
Resposta de sucesso

Confirma a desvinculação devolvendo a contagem em message (formato "Unlinked N of M groups from community"). Por reuso do DTO compartilhado com /link, o array linked contém aqui os JIDs desvinculados com sucesso e failed os que falharam. success é true quando ao menos um grupo foi desvinculado, mesmo em sucesso parcial, sempre cheque failed[] para detectar erros por grupo.
200 OK
{
  "success": true,
  "message": "Unlinked 2 of 2 groups from community",
  "linked": [
    "120363406289005074@g.us",
    "120363406289005075@g.us"
  ],
  "failed": []
}

​
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
JIDs dos grupos a desvincular. Pelo menos 1 item.

​
Notas

  • O Grupo de Anúncios da comunidade não pode ser desvinculado, para excluir o announcement, é preciso deletar a comunidade inteira (não exposto nesta API).
  • Os membros dos grupos continuam onde estavam, apenas a relação pai-filho é removida.
  • Para mover um grupo entre comunidades, desvincule daqui e use /link na nova.

​
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

Vincular grupos

Reconectar a outra comunidade.

Listar subgrupos

Confirmar que o grupo foi removido.