PATCH
/
groups
/
{groupId}
curl --request PATCH \
  --url https://api.zapperapi.com/{instanceId}/groups/{groupId} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "displayPicture": "<string>",
  "announcement": true,
  "locked": true
}'

Authorizations

​
X-Api-Key
string
header
required

Chave privada da API

Path Parameters

​
groupId
string
required

Id do grupo, com ou sem o sufixo @g.us

Body

application/json
​
name
string

Novo nome do grupo

​
description
string

Nova descrição do grupo

​
displayPicture
string | null

Nova imagem de perfil do grupo, podendo ser uma URL, o arquivo no formato base64 ou uma Data URI no formato base64. Caso enviar o valor null, a imagem atual será removida.

​
announcement
boolean

Indica se o grupo só permite postagens dos admins

​
locked
boolean

Indica se o grupo é bloqueado para edição e somente pode ser alterado por admins

Response

200

Default Response