Skip to main content
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": {}
}
'

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.

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

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

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

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

​
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

​
instance
string
required
Instance name.

​
Headers

​
token
string
required
TokenAccount or TokenInstance.
​
Content-Type
string
required
application/json

​
Request body

​
identifier
string
required
Group JID, code, or link.
​
name
string
New name. Max 25 characters.
​
description
string
New description (topic). An empty string ("") removes the description.
​
image
string
URL or base64. The image is converted to JPEG before upload.
​
removeImage
boolean
When true, removes the current picture. Takes precedence over image.
​
groupSettings
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

HTTPMessage
400At least one field must be provided to update
400group name must be 25 characters or less
400Identifier is required
403Not authorized to update this group (must be admin)
404Group 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)" }
}