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

# Atualizar Grupo

> Atualiza nome, descrição, foto e permissões de um grupo existente

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

## Descrição

Atualiza qualquer subconjunto de campos do grupo: `name`, `description`, `image`, `groupSettings`. **Pelo menos um campo** além de `identifier` precisa ser enviado. A `message` da resposta lista os campos efetivamente atualizados.

## Exemplos

### Atualizar nome

Renomeia o grupo `120363406289005073@g.us` para "Time Dev Updated", deixando descrição, foto e permissões inalteradas.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT "https://ryzeapi.cloud/api/group/update/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "identifier": "120363406289005073@g.us",
      "name": "Time Dev Updated"
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/group/update/${process.env.Instance_Name}`, {
    method: "PUT",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      identifier: "120363406289005073@g.us",
      name:       "Time Dev Updated"
    })
  });
  ```

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

  requests.put(
      f"https://ryzeapi.cloud/api/group/update/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "identifier": "120363406289005073@g.us",
          "name":       "Time Dev Updated"
      }
  )
  ```

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

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

  func main() {
      body := strings.NewReader(`{
          "identifier": "120363406289005073@g.us",
          "name":       "Time Dev Updated"
      }`)
      req, _ := http.NewRequest("PUT", "https://ryzeapi.cloud/api/group/update/"+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>

### Atualizar vários campos

Atualiza nome, descrição, foto e permissões de uma só vez: somente admins podem enviar mensagens (`membersCanSendMessages: false`) e novas entradas precisam de aprovação (`requireAdminApproval: true`).

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT "https://ryzeapi.cloud/api/group/update/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "identifier": "120363406289005073@g.us",
      "name": "Time Dev",
      "description": "Nova descrição",
      "image": "https://exemplo.com/logo.png",
      "groupSettings": {
        "membersCanSendMessages": false,
        "requireAdminApproval": true
      }
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/group/update/${process.env.Instance_Name}`, {
    method: "PUT",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      identifier:   "120363406289005073@g.us",
      name:         "Time Dev",
      description:  "Nova descrição",
      image:        "https://exemplo.com/logo.png",
      groupSettings: {
        membersCanSendMessages: false,
        requireAdminApproval:   true
      }
    })
  });
  ```

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

  requests.put(
      f"https://ryzeapi.cloud/api/group/update/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "identifier":  "120363406289005073@g.us",
          "name":        "Time Dev",
          "description": "Nova descrição",
          "image":       "https://exemplo.com/logo.png",
          "groupSettings": {
              "membersCanSendMessages": False,
              "requireAdminApproval":   True
          }
      }
  )
  ```

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

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

  func main() {
      body := strings.NewReader(`{
          "identifier": "120363406289005073@g.us",
          "name": "Time Dev",
          "description": "Nova descrição",
          "image": "https://exemplo.com/logo.png",
          "groupSettings": {
              "membersCanSendMessages": false,
              "requireAdminApproval": true
          }
      }`)
      req, _ := http.NewRequest("PUT", "https://ryzeapi.cloud/api/group/update/"+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>

### Remover foto

Apaga a foto do grupo enviando `removeImage: true`. Esse flag tem precedência sobre `image`, útil para zerar a imagem sem precisar fornecer outra.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT "https://ryzeapi.cloud/api/group/update/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "identifier": "120363406289005073@g.us",
      "removeImage": true
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/group/update/${process.env.Instance_Name}`, {
    method: "PUT",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      identifier:  "120363406289005073@g.us",
      removeImage: true
    })
  });
  ```

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

  requests.put(
      f"https://ryzeapi.cloud/api/group/update/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "identifier":  "120363406289005073@g.us",
          "removeImage": True
      }
  )
  ```

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

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

  func main() {
      body := strings.NewReader(`{
          "identifier": "120363406289005073@g.us",
          "removeImage": true
      }`)
      req, _ := http.NewRequest("PUT", "https://ryzeapi.cloud/api/group/update/"+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>

### Limpar descrição

Zera a descrição (tópico) do grupo enviando `description: ""`. String vazia é tratada explicitamente como remover, diferente de omitir o campo, que mantém a descrição atual.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT "https://ryzeapi.cloud/api/group/update/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "identifier": "120363406289005073@g.us",
      "description": ""
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/group/update/${process.env.Instance_Name}`, {
    method: "PUT",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      identifier:  "120363406289005073@g.us",
      description: ""
    })
  });
  ```

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

  requests.put(
      f"https://ryzeapi.cloud/api/group/update/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "identifier":  "120363406289005073@g.us",
          "description": ""
      }
  )
  ```

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

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

  func main() {
      body := strings.NewReader(`{
          "identifier": "120363406289005073@g.us",
          "description": ""
      }`)
      req, _ := http.NewRequest("PUT", "https://ryzeapi.cloud/api/group/update/"+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 `message` lista somente os campos **efetivamente** alterados (útil para confirmar quando um valor enviado já era o atual). O objeto `group` traz o estado pós-update completo, incluindo `groupSettings` resultantes e o `inviteLink` corrente.

```json 200 OK theme={null}
{
  "success": true,
  "message": "Group name, description, announce setting updated successfully",
  "group": {
    "name": "Time Dev",
    "jid": "120363406289005073@g.us",
    "description": "Nova descrição",
    "inviteCode": "ABC123XYZ",
    "inviteLink": "https://chat.whatsapp.com/ABC123XYZ",
    "createdBy": "5511999999999@s.whatsapp.net",
    "participantCount": 3,
    "groupSettings": {
      "membersCanEditInfo": true,
      "membersCanSendMessages": false,
      "membersCanAddOthers": false,
      "requireAdminApproval": true
    },
    "isCommunity": false,
    "isParent": false,
    "linkedParentJid": null
  }
}
```

## 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="identifier" type="string" required>
  JID, código ou link do grupo.
</ParamField>

<ParamField body="name" type="string">
  Novo nome. Máximo de **25 caracteres**.
</ParamField>

<ParamField body="description" type="string">
  Nova descrição (tópico). String vazia (`""`) **remove** a descrição.
</ParamField>

<ParamField body="image" type="string">
  URL ou base64. A imagem é convertida para JPEG antes do upload.
</ParamField>

<ParamField body="removeImage" type="boolean">
  Quando `true`, **remove** a foto atual. Tem **precedência** sobre `image`.
</ParamField>

<ParamField body="groupSettings" type="object">
  Atualização parcial das permissões. Subcampos: `membersCanEditInfo`, `membersCanSendMessages`, `membersCanAddOthers`, `requireAdminApproval`.
</ParamField>

## Notas

<Note>
  * `removeImage: true` ignora qualquer valor enviado em `image`.
  * A `message` da resposta lista somente os campos **efetivamente** alterados, útil para confirmar quando um valor enviado já era o atual.
  * A ordem interna de execução é: name -> description -> photo/removeImage -> settings. Se algum passo falha, os anteriores **já foram aplicados** e não são revertidos.
  * `description: ""` zera a descrição, não é equivalente a omitir o campo.
</Note>

## Erros

| HTTP | Mensagem                                                |
| ---- | ------------------------------------------------------- |
| 400  | `At least one field must be provided to update`         |
| 400  | `group name must be 25 characters or less`              |
| 400  | `Identifier is required`                                |
| 403  | `Not authorized to update this group (must be admin)`   |
| 404  | `Group not found or you are not a member of this group` |

Envelope:

```json theme={null}
{
  "success": false,
  "error": { "message": "Not authorized to update this group (must be admin)" }
}
```