> ## 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.

# Vincular grupos

> Vincula grupos existentes a uma comunidade como subgrupos

**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.

<CodeGroup>
  ```bash cURL theme={null}
  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"
      ]
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/community/link/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      communityJid: "120363406289005073@g.us",
      groupJid: [
        "120363406289005074@g.us",
        "120363406289005075@g.us"
      ]
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/community/link/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "communityJid": "120363406289005073@g.us",
          "groupJid": [
              "120363406289005074@g.us",
              "120363406289005075@g.us"
          ]
      }
  )
  ```

  ```go Go theme={null}
  package main

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

  func main() {
      body := strings.NewReader(`{
          "communityJid": "120363406289005073@g.us",
          "groupJid": [
              "120363406289005074@g.us",
              "120363406289005075@g.us"
          ]
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/community/link/"+os.Getenv("Instance_Name"), body)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      req.Header.Set("Content-Type", "application/json")
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

### 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.

<CodeGroup>
  ```bash cURL theme={null}
  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"]
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/community/link/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      communityJid: "120363406289005073@g.us",
      groupJid: ["120363406289005074@g.us"]
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/community/link/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "communityJid": "120363406289005073@g.us",
          "groupJid":     ["120363406289005074@g.us"]
      }
  )
  ```

  ```go Go theme={null}
  package main

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

  func main() {
      body := strings.NewReader(`{
          "communityJid": "120363406289005073@g.us",
          "groupJid": ["120363406289005074@g.us"]
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/community/link/"+os.Getenv("Instance_Name"), body)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      req.Header.Set("Content-Type", "application/json")
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

## 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.

```json 200 OK theme={null}
{
  "success": true,
  "message": "Linked 2 of 2 groups to community",
  "linked": [
    "120363406289005074@g.us",
    "120363406289005075@g.us"
  ],
  "failed": []
}
```

<Warning>
  Sucesso parcial e falha total retornam **HTTP 200**. Sempre cheque `success` + `failed[]` no cliente para detectar erros por grupo.
</Warning>

## Parâmetros de rota

<ParamField path="instance" type="string" required>
  Nome da instância.
</ParamField>

## Headers

<ParamField header="token" type="string" required>
  `TokenAccount` ou `TokenInstance`.
</ParamField>

<ParamField header="Content-Type" type="string" required>
  `application/json`
</ParamField>

## Request body

<ParamField body="communityJid" type="string" required>
  JID `@g.us` da comunidade.
</ParamField>

<ParamField body="groupJid" type="string[]" required>
  Array de JIDs `@g.us` dos grupos a vincular. Pelo menos **1** item.
</ParamField>

## Notas

<Note>
  * Grupo já vinculado a **outra comunidade** cai em `failed[]`, desvincule antes via [`/unlink`](/pt/api/communities/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.
</Note>

## Erros

| HTTP | Mensagem                                |
| ---- | --------------------------------------- |
| 400  | `community jid is required`             |
| 400  | `group jid is required`                 |
| 400  | `Instance is not connected to WhatsApp` |
| 500  | `error parse community jid: <reason>`   |

Envelope:

```json theme={null}
{
  "success": false,
  "error": { "message": "community jid is required" }
}
```

## Próximo

<CardGroup cols={2}>
  <Card title="Desvincular grupos" icon="link-slash" href="/pt/api/communities/unlink">
    Remover grupos da comunidade.
  </Card>

  <Card title="Listar subgrupos" icon="list" href="/pt/api/communities/list-subgroups">
    Confirmar os subgrupos vinculados.
  </Card>
</CardGroup>