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

# Criar Grupo

> Cria um novo grupo de WhatsApp com participantes, descrição, foto e permissões iniciais

**Auth:** `TokenAccount` ou `TokenInstance` • **Rate-limit:** `Global` (100/min) • **Idempotente:** não

## Descrição

Cria um grupo de WhatsApp e o vincula opcionalmente a uma comunidade existente (`communityJid`). Você pode definir nome, descrição, foto e permissões iniciais (`groupSettings`) na mesma chamada. A foto e a descrição são aplicadas em chamadas subsequentes após a criação do grupo.

## Exemplos

### Mínimo

Cria um grupo "Time de Dev" com 2 participantes iniciais (`5511999999999`, `5521988888888`), sem descrição, foto, comunidade nem permissões customizadas.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/group/create/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "Time de Dev",
      "participants": ["5511999999999", "5521988888888"]
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/group/create/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      name:         "Time de Dev",
      participants: ["5511999999999", "5521988888888"]
    })
  });
  ```

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

  requests.post(
      f"https://ryzeapi.cloud/api/group/create/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "name":         "Time de Dev",
          "participants": ["5511999999999", "5521988888888"]
      }
  )
  ```

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

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

  func main() {
      body := strings.NewReader(`{
          "name": "Time de Dev",
          "participants": ["5511999999999", "5521988888888"]
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/group/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)
  }
  ```
</CodeGroup>

### Com descrição e foto

Cria o grupo já com a descrição "Discussões técnicas" e foto vinda de uma URL pública. Descrição e imagem são aplicadas em chamadas subsequentes após a criação do grupo.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/group/create/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "Time de Dev",
      "description": "Discussões técnicas",
      "image": "https://exemplo.com/logo.png",
      "participants": ["5511999999999", "5521988888888"]
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/group/create/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      name:         "Time de Dev",
      description:  "Discussões técnicas",
      image:        "https://exemplo.com/logo.png",
      participants: ["5511999999999", "5521988888888"]
    })
  });
  ```

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

  requests.post(
      f"https://ryzeapi.cloud/api/group/create/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "name":         "Time de Dev",
          "description":  "Discussões técnicas",
          "image":        "https://exemplo.com/logo.png",
          "participants": ["5511999999999", "5521988888888"]
      }
  )
  ```

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

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

  func main() {
      body := strings.NewReader(`{
          "name": "Time de Dev",
          "description": "Discussões técnicas",
          "image": "https://exemplo.com/logo.png",
          "participants": ["5511999999999", "5521988888888"]
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/group/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)
  }
  ```
</CodeGroup>

### Com permissões

Cria um grupo "Anúncios" com restrições iniciais: somente admins podem enviar mensagens (`membersCanSendMessages: false`) e novas entradas precisam de aprovação (`requireAdminApproval: true`).

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/group/create/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "Anúncios",
      "participants": ["5511999999999"],
      "groupSettings": {
        "membersCanSendMessages": false,
        "requireAdminApproval": true
      }
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/group/create/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      name:         "Anúncios",
      participants: ["5511999999999"],
      groupSettings: {
        membersCanSendMessages: false,
        requireAdminApproval:   true
      }
    })
  });
  ```

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

  requests.post(
      f"https://ryzeapi.cloud/api/group/create/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "name":         "Anúncios",
          "participants": ["5511999999999"],
          "groupSettings": {
              "membersCanSendMessages": False,
              "requireAdminApproval":   True
          }
      }
  )
  ```

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

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

  func main() {
      body := strings.NewReader(`{
          "name": "Anúncios",
          "participants": ["5511999999999"],
          "groupSettings": {
              "membersCanSendMessages": false,
              "requireAdminApproval": true
          }
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/group/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)
  }
  ```
</CodeGroup>

### Vinculado a comunidade

Cria o grupo "Subgrupo Geral" já vinculado à comunidade `120363406289005073@g.us` via `communityJid`, evitando o passo extra de chamar `/community/link` após a criação.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/group/create/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "Subgrupo Geral",
      "participants": ["5511999999999"],
      "communityJid": "120363406289005073@g.us"
    }'
  ```

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

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

  requests.post(
      f"https://ryzeapi.cloud/api/group/create/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "name":         "Subgrupo Geral",
          "participants": ["5511999999999"],
          "communityJid": "120363406289005073@g.us"
      }
  )
  ```

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

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

  func main() {
      body := strings.NewReader(`{
          "name": "Subgrupo Geral",
          "participants": ["5511999999999"],
          "communityJid": "120363406289005073@g.us"
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/group/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)
  }
  ```
</CodeGroup>

## Resposta de sucesso

A resposta inclui o `group.jid` recém-criado (use-o como `identifier` nas chamadas subsequentes), o `inviteCode` e `inviteLink` prontos para compartilhar e a lista de `participants` já marcada com `isAdmin`/`isSuperAdmin`. O criador entra automaticamente como super-admin. Os campos `groupSettings` refletem as permissões iniciais (defaults ou o que foi enviado).

```json 200 OK theme={null}
{
  "success": true,
  "message": "Group created successfully",
  "group": {
    "name": "Time de Dev",
    "jid": "120363406289005073@g.us",
    "description": "Discussões técnicas",
    "inviteCode": "ABC123XYZ",
    "inviteLink": "https://chat.whatsapp.com/ABC123XYZ",
    "createdBy": "5511999999999@s.whatsapp.net",
    "participantCount": 3,
    "participants": [
      { "jid": "5511999999999@s.whatsapp.net", "isAdmin": true, "isSuperAdmin": false }
    ],
    "groupSettings": {
      "membersCanEditInfo": true,
      "membersCanSendMessages": true,
      "membersCanAddOthers": false,
      "requireAdminApproval": false
    },
    "isCommunity": false,
    "isParent": false,
    "linkedParentJid": null
  }
}
```

## Parâmetros de rota

<ParamField path="instance" type="string" required>
  Nome da instância (ex.: `$Instance_Name`).
</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="name" type="string" required>
  Nome do grupo. Máximo de **25 caracteres**.
</ParamField>

<ParamField body="participants" type="string[]" required>
  Lista de números (`5511999999999`) ou JIDs (`5511999999999@s.whatsapp.net`). Pelo menos **1** item.
</ParamField>

<ParamField body="description" type="string">
  Descrição (tópico) do grupo. Aplicada via `SetGroupTopic` após a criação.
</ParamField>

<ParamField body="image" type="string">
  URL pública ou data URI base64. A imagem é convertida para JPEG.
</ParamField>

<ParamField body="communityJid" type="string">
  Cria o grupo já vinculado a uma comunidade (parent group).
</ParamField>

<ParamField body="groupSettings" type="object">
  Permissões iniciais. Subcampos: `membersCanEditInfo`, `membersCanSendMessages`, `membersCanAddOthers`, `requireAdminApproval`.
</ParamField>

## Notas

<Note>
  * O criador do grupo entra automaticamente como **super-admin**.
  * Números inválidos (não registrados no WhatsApp) são rejeitados; o erro indica qual participante falhou.
  * Se `image` for passada e o upload falhar, a criação do grupo segue normalmente, o erro de imagem não é fatal nesta rota. Use [`PUT /update`](/pt/api/groups/update) para reaplicar a foto.
</Note>

## Erros

| HTTP | Mensagem                                                |
| ---- | ------------------------------------------------------- |
| 400  | `The 'name' field is required`                          |
| 400  | `At least one participant is required`                  |
| 400  | `group name must be 25 characters or less`              |
| 400  | `invalid participant <number>: <reason>`                |
| 400  | `Instance is not connected to WhatsApp`                 |
| 429  | `rate limit exceeded (429): wait before creating again` |

Envelope:

```json theme={null}
{
  "success": false,
  "error": { "message": "The 'name' field is required" }
}
```