Pular para o conteúdo principal
PUT
/
api
/
group
/
update
/
:instance
Atualizar 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 ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: parcial (mesmos valores não geram efeito)

​
Descrição

Atualiza qualquer subconjunto de campos do grupo: name, description, image, groupSettings. Pelo menos um campo além de identifier precisa ser enviado. A message da resposta lista os campos efetivamente atualizados.

​
Exemplos

​
Atualizar nome

Renomeia o grupo 120363406289005073@g.us para “Time Dev Updated”, deixando descrição, foto e permissões inalteradas. 
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": "Time Dev Updated"
  }'

​
Atualizar vários campos

Atualiza nome, descrição, foto e permissões de uma só vez: somente admins podem enviar mensagens (membersCanSendMessages: false) e novas entradas precisam de aprovação (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": "Time Dev",
    "description": "Nova descrição",
    "image": "https://exemplo.com/logo.png",
    "groupSettings": {
      "membersCanSendMessages": false,
      "requireAdminApproval": true
    }
  }'

​
Remover foto

Apaga a foto do grupo enviando removeImage: true. Esse flag tem precedência sobre image, útil para zerar a imagem sem precisar fornecer outra. 
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
  }'

​
Limpar descrição

Zera a descrição (tópico) do grupo enviando description: "". String vazia é tratada explicitamente como remover, diferente de omitir o campo, que mantém a descrição atual. 
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": ""
  }'

​
Resposta de sucesso

A message lista somente os campos efetivamente alterados (útil para confirmar quando um valor enviado já era o atual). O objeto group traz o estado pós-update completo, incluindo groupSettings resultantes e o inviteLink corrente.
200 OK
{
  "success": true,
  "message": "Group name, description, announce setting updated successfully",
  "group": {
    "name": "Time Dev",
    "jid": "120363406289005073@g.us",
    "description": "Nova descrição",
    "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 rota

​
instance
string
obrigatório
Nome da instância.

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.
​
Content-Type
string
obrigatório
application/json

​
Request body

​
identifier
string
obrigatório
JID, código ou link do grupo.
​
name
string
Novo nome. Máximo de 25 caracteres.
​
description
string
Nova descrição (tópico). String vazia ("") remove a descrição.
​
image
string
URL ou base64. A imagem é convertida para JPEG antes do upload.
​
removeImage
boolean
Quando true, remove a foto atual. Tem precedência sobre image.
​
groupSettings
object
Atualização parcial das permissões. Subcampos: membersCanEditInfo, membersCanSendMessages, membersCanAddOthers, requireAdminApproval.

​
Notas

  • removeImage: true ignora qualquer valor enviado em image.
  • A message da resposta lista somente os campos efetivamente alterados, útil para confirmar quando um valor enviado já era o atual.
  • A ordem interna de execução é: name -> description -> photo/removeImage -> settings. Se algum passo falha, os anteriores já foram aplicados e não são revertidos.
  • description: "" zera a descrição, não é equivalente a omitir o campo.

​
Erros

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