Saltar al contenido principal
PUT
/
api
/
group
/
update
/
:instance
Actualizar grupo
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 o TokenInstance • Rate-limit: Global (100/min) • Idempotente: parcial (enviar los mismos valores no produce efecto)

​
Descripción

Actualiza cualquier subconjunto de campos del grupo: name, description, image, groupSettings. Debe enviarse al menos un campo además de identifier. El message de la respuesta lista los campos que realmente fueron actualizados.

​
Ejemplos

​
Actualizar nombre

Renombra el grupo 120363406289005073@g.us a “Dev Team Updated”, dejando descripción, imagen y permisos sin cambios. 
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"
  }'

​
Actualizar múltiples campos

Actualiza nombre, descripción, imagen y permisos en una sola llamada: solo los administradores pueden enviar mensajes (membersCanSendMessages: false) y las nuevas uniones requieren aprobación (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
    }
  }'

​
Eliminar imagen

Elimina la imagen del grupo enviando removeImage: true. Este flag tiene precedencia sobre image, útil para limpiar la imagen sin proporcionar una nueva. 
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
  }'

​
Limpiar descripción

Limpia la descripción del grupo (topic) enviando description: "". Una cadena vacía se trata explícitamente como “eliminar”, diferente de omitir el campo, que mantiene la descripción actual. 
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": ""
  }'

​
Respuesta exitosa

El message lista solo los campos que realmente cambiaron (útil para confirmar cuando un valor que enviaste ya coincidía con el actual). El objeto group lleva el estado completo posterior a la actualización, incluyendo los groupSettings resultantes y el inviteLink actual.
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
  }
}

​
Parámetros de ruta

​
instance
string
requerido
Nombre de la instancia.

​
Cabeceras

​
token
string
requerido
TokenAccount o TokenInstance.
​
Content-Type
string
requerido
application/json

​
Cuerpo de la solicitud

​
identifier
string
requerido
JID, código o enlace del grupo.
​
name
string
Nuevo nombre. Máximo 25 caracteres.
​
description
string
Nueva descripción (topic). Una cadena vacía ("") elimina la descripción.
​
image
string
URL o base64. La imagen se convierte a JPEG antes de la subida.
​
removeImage
boolean
Cuando es true, elimina la imagen actual. Tiene precedencia sobre image.
​
groupSettings
object
Actualización parcial de los permisos. Subcampos: membersCanEditInfo, membersCanSendMessages, membersCanAddOthers, requireAdminApproval.

​
Notas

  • removeImage: true ignora cualquier valor enviado en image.
  • El message de la respuesta lista solo los campos realmente cambiados, útil para confirmar cuando un valor que enviaste ya coincidía con el actual.
  • El orden de ejecución interno es: nombre -> descripción -> foto/removeImage -> ajustes. Si un paso falla, los anteriores ya se aplicaron y no se revierten.
  • description: "" limpia la descripción, no es equivalente a omitir el campo.

​
Errores

HTTPMensaje
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
Envoltorio: 
{
  "success": false,
  "error": { "message": "Not authorized to update this group (must be admin)" }
}