Update Group

PUT

api

group

update

:instance

Update Group

curl --request PUT \
  --url https://api.example.com/api/group/update/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "identifier": "<string>",
  "name": "<string>",
  "description": "<string>",
  "image": "<string>",
  "removeImage": true,
  "groupSettings": {}
}
'

const options = {
  method: 'PUT',
  headers: {token: '<token>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    identifier: '<string>',
    name: '<string>',
    description: '<string>',
    image: '<string>',
    removeImage: true,
    groupSettings: {}
  })
};

fetch('https://api.example.com/api/group/update/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/group/update/:instance"

payload = {
    "identifier": "<string>",
    "name": "<string>",
    "description": "<string>",
    "image": "<string>",
    "removeImage": True,
    "groupSettings": {}
}
headers = {
    "token": "<token>",
    "Content-Type": "<content-type>"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

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.

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"
  }'

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"
  })
});

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"
    }
)

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

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

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

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
    }
  })
});

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

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

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.

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

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
  })
});

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

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

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.

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": ""
  }'

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: ""
  })
});

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": ""
    }
)

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

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.

200 OK

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

string

required

Instance name.

Headers

string

required

TokenAccount or TokenInstance.

string

required

application/json

Request body

string

required

Group JID, code, or link.

string

New name. Max 25 characters.

string

New description (topic). An empty string ("") removes the description.

string

URL or base64. The image is converted to JPEG before upload.

boolean

When true, removes the current picture. Takes precedence over image.

object

Partial update of the permissions. Subfields: membersCanEditInfo, membersCanSendMessages, membersCanAddOthers, requireAdminApproval.

Notes

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.

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:

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

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Description

Examples

Update name

Update multiple fields

Remove picture

Clear description

Success response

Path parameters

Headers

Request body

Notes

Errors

​Description

​Examples

​Update name

​Update multiple fields

​Remove picture

​Clear description

​Success response

​Path parameters

​Headers

​Request body

​Notes

​Errors

Description

Examples

Update name

Update multiple fields

Remove picture

Clear description

Success response

Path parameters

Headers

Request body

Notes

Errors