Pular para o conteúdo principal
PATCH
/
wa
/
instances
/
{instance_id}
/
groups
/
{group_id}
Atualizar Dados de Grupo
curl --request PATCH \
  --url https://api.example.com/wa/instances/{instance_id}/groups/{group_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "is_announcement": true,
  "is_restricted": true,
  "name": "My New Group Name",
  "profile_picture": "<string>"
}
'
{
  "description": "My group description",
  "id": "120363279776130958",
  "invite_code": "XobOM8UBL8EXR3dXoGozql",
  "is_announcement": true,
  "is_restricted": true,
  "name": "My group name",
  "owner": {
    "id": "558796139874",
    "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
    "name": "Owner Name"
  },
  "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/...",
  "total_participants": 2,
  "is_community": true,
  "approval_mode": "requires_approval"
}
Utilize este endpoint para atualizar os campos name (Nome), profile_picture (Foto de perfil) e/ou description (Descrição do perfil) de um determinado. Todas as atualizações são opcionais, ou seja, apenas as informações presentes no corpo da requisição serão alteradas.

Autorizações

​
Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

​
instance_id
string
obrigatório

ID da instância onde o grupo de encontra.

​
group_id
string
obrigatório

ID do grupo que será atualizado

Corpo

application/json
​
description
string

Opcional. Se informado, irá substituir a descrição atual do grupo.

​
is_announcement
boolean

Define se o grupo será apenas para anúncios (ninguém pode enviar mensagens, só o dono).

Exemplo:

true

​
is_restricted
boolean

Define se o grupo terá acesso restrito (apenas pessoas autorizadas podem participar).

Exemplo:

true

​
name
string

Novo nome para o grupo.

Exemplo:

"My New Group Name"

​
profile_picture
string<uri>

Foto de perfil, pode ser uma string no formato base64 ou uma url (publicamente acessível).

Resposta

200 - application/json

Success

​
description
string
obrigatório

Descrição do grupo que também pode ser vista na seção de detalhamento do grupo.

Exemplo:

"My group description"

​
id
string
obrigatório

Identificador único do grupo.

Exemplo:

"120363279776130958"

​
invite_code
string | null
obrigatório

Código do convite do grupo que pode ser usado para convitar outros usuários.

Exemplo:

"XobOM8UBL8EXR3dXoGozql"

​
is_announcement
boolean
obrigatório

Indica se o grupo é apenas para anúncios (ninguém pode enviar mensagens, só o dono).

Exemplo:

true

​
is_restricted
boolean
obrigatório

Mostra se o grupo tem acesso restrito (apenas pessoas autorizadas podem participar).

Exemplo:

true

​
name
string
obrigatório

O nome dado ao grupo.

Exemplo:

"My group name"

​
owner
object
obrigatório
​
profile_picture
string<uri>
obrigatório

Profile picture URL of the group.

Exemplo:

"https://zapsterapi.s3.us-east-1.amazonaws.com/..."

​
total_participants
integer
obrigatório

Total number of participants in the group.

Exemplo:

2

​
is_community
boolean

Indica se o grupo é uma comunidade (pode ser um grupo de anúncios).

Exemplo:

true

​
approval_mode
enum<string>

Define como os participantes serão aprovados no grupo.

Opções disponíveis:
auto_approve,
requires_approval
Exemplo:

"requires_approval"