Actualizar grupo

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

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

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

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

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

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

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

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

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

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

string

requerido

Nombre de la instancia.

Cabeceras

string

requerido

TokenAccount o TokenInstance.

string

requerido

application/json

Cuerpo de la solicitud

string

requerido

JID, código o enlace del grupo.

string

Nuevo nombre. Máximo 25 caracteres.

string

Nueva descripción (topic). Una cadena vacía ("") elimina la descripción.

string

URL o base64. La imagen se convierte a JPEG antes de la subida.

boolean

Cuando es true, elimina la imagen actual. Tiene precedencia sobre image.

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

HTTP	Mensaje
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`

Envoltorio:

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

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Actualizar grupo

Descripción

Ejemplos

Actualizar nombre

Actualizar múltiples campos

Eliminar imagen

Limpiar descripción

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Notas

Errores

​Descripción

​Ejemplos

​Actualizar nombre

​Actualizar múltiples campos

​Eliminar imagen

​Limpiar descripción

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Cuerpo de la solicitud

​Notas

​Errores

Descripción

Ejemplos

Actualizar nombre

Actualizar múltiples campos

Eliminar imagen

Limpiar descripción

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Notas

Errores