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

# Update Group

> Update name, description, picture, and permissions of an existing group

**Auth:** `TokenAccount` or `TokenInstance` • **Rate-limit:** `Global` (100/min) • **Idempotent:** partial (sending the same values produces no effect)

## Description

Updates any subset of group fields: `name`, `description`, `image`, `groupSettings`. **At least one field** beyond `identifier` must be sent. The response's `message` lists the fields that were actually updated.

## Examples

### Update name

Renames the group `120363406289005073@g.us` to "Dev Team Updated", leaving description, picture, and permissions unchanged.

<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": "Dev Team 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:       "Dev Team 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":       "Dev Team Updated"
      }
  )
  ```

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

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

  func main() {
      body := strings.NewReader(`{
          "identifier": "120363406289005073@g.us",
          "name":       "Dev Team 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>

### Update multiple fields

Updates name, description, picture, and permissions in one shot: only admins can send messages (`membersCanSendMessages: false`) and new joins require approval (`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": "Dev Team",
      "description": "New description",
      "image": "https://example.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:         "Dev Team",
      description:  "New description",
      image:        "https://example.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":        "Dev Team",
          "description": "New description",
          "image":       "https://example.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": "Dev Team",
          "description": "New description",
          "image": "https://example.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>

### Remove picture

Deletes the group picture by sending `removeImage: true`. This flag takes precedence over `image`, useful for clearing the picture without providing a new one.

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

### Clear description

Clears the group description (topic) by sending `description: ""`. An empty string is treated explicitly as "remove", different from omitting the field, which keeps the current description.

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

## Success response

The `message` lists only the fields that were **actually** changed (handy for confirming when a value you sent already matched the current one). The `group` object carries the full post-update state, including the resulting `groupSettings` and the current `inviteLink`.

```json 200 OK theme={null}
{
  "success": true,
  "message": "Group name, description, announce setting updated successfully",
  "group": {
    "name": "Dev Team",
    "jid": "120363406289005073@g.us",
    "description": "New description",
    "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
  }
}
```

## Path parameters

<ParamField path="instance" type="string" required>
  Instance name.
</ParamField>

## Headers

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

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

## Request body

<ParamField body="identifier" type="string" required>
  Group JID, code, or link.
</ParamField>

<ParamField body="name" type="string">
  New name. Max **25 characters**.
</ParamField>

<ParamField body="description" type="string">
  New description (topic). An empty string (`""`) **removes** the description.
</ParamField>

<ParamField body="image" type="string">
  URL or base64. The image is converted to JPEG before upload.
</ParamField>

<ParamField body="removeImage" type="boolean">
  When `true`, **removes** the current picture. Takes **precedence** over `image`.
</ParamField>

<ParamField body="groupSettings" type="object">
  Partial update of the permissions. Subfields: `membersCanEditInfo`, `membersCanSendMessages`, `membersCanAddOthers`, `requireAdminApproval`.
</ParamField>

## Notes

<Note>
  * `removeImage: true` ignores any value sent in `image`.
  * The response's `message` lists only the fields **actually** changed, handy for confirming when a value you sent already matched the current one.
  * The internal execution order is: name -> description -> photo/removeImage -> settings. If a step fails, the previous ones **have already been applied** and are not rolled back.
  * `description: ""` clears the description, it is not equivalent to omitting the field.
</Note>

## Errors

| HTTP | Message                                                 |
| ---- | ------------------------------------------------------- |
| 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)" }
}
```