1. Grupos
  • Raiz
    • Webhooks
      • Criar ou atualizar webhook
      • Desativar webhook
    • Instâncias
      • Listar instâncias
      • Criar instância
      • Atualizar nome da instância
      • Remover instância
      • Listar chats da instância
      • Conectar instância
      • Desconectar instância
      • Listar newsletters inscritas
      • Consultar detalhes de newsletter
      • Consultar último QR code da instância
      • Consultar status da instância
    • Mensagens
      • Enviar mensagem com imagem
      • Enviar mensagem com prévia de link
      • Listar mensagens pendentes
      • Cancelar mensagens pendentes
      • Enviar mensagem de texto
      • Enviar mensagem mencionando participantes do grupo
    • Grupos
      • Criar grupo
        POST
      • Atualizar nome do grupo
        PATCH
      • Alterar descrição do grupo
        PATCH
      • Atualizar imagem do grupo
        PATCH
      • Adicionar participantes ao grupo
        POST
      • Remover participantes do grupo
        DELETE
      • Consultar detalhes de grupo
        GET
  1. Grupos

Alterar descrição do grupo

Amb. de Produção
https://api.way-api.io
Amb. de Produção
https://api.way-api.io
PATCH
/instances/{instanceId}/groups/{groupChatId}/description
Última modificação:2026-09-23 01:41:33
Atualiza a descrição do grupo. Para removê-la, envie description: null. A conta conectada precisa ter permissão para editar o grupo. Disponível para instâncias Zapo.

Requisição

Authorization
Adicionar parâmetro em header
x-api-key
Exemplo:
x-api-key: ********************
Parâmetros de Caminho

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200OK
application/json
The request has succeeded.
Bodyapplication/json

🟠400Requisição Inválida
🟠401Não Autorizado
🟠403Proibido
🟠404Registo Não Encontrado
🟠422Erro de Parâmetro
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://api.way-api.io/instances//groups//description' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "description": "string"
}'
Response Response Example
200 - Exemplo 1
{
    "chatId": "string",
    "status": "updated"
}
Modificado em 2026-09-23 01:41:33
Página anterior
Atualizar nome do grupo
Próxima página
Atualizar imagem do grupo
Built with