PATCH
/
wa
/
instances
/
{instance_id}
/
groups
/
{group_id}
curl --request PATCH \
  --url https://api.zapsterapi.com/v1/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": "BobOM8UXL8EDR3dXoKozql",
  "is_announcement": true,
  "is_restricted": true,
  "name": "My group name",
  "owner": {
    "id": "558796139874",
    "name": "Owner Name",
    "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/..."
  },
  "profile_picture": "https://zapsterapi.s3.us-east-1.amazonaws.com/instances/i-7360mtucxawrpqwxxfll1/profile-pictures/hrs9ncawv3r7euulclfk684dfq9vgi7r.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAV6PM7KXCEFS4IW3T%2F20240526%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240526T235811Z&X-Amz-Expires=86400&X-Amz-Signature=dba5db50b719f5e9454ab8e9fac479c3d6dfa712842886d2da20c36595aab1dc&X-Amz-SignedHeaders=host&x-id=GetObject",
  "total_participants": 2
}

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.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
instance_id
string
required

ID da instância onde o grupo de encontra.

​
group_id
string
required

ID do grupo que será atualizado

Body

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

Example:

true

​
is_restricted
boolean

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

Example:

true

​
name
string

Novo nome para o grupo.

Example:

"My New Group Name"

​
profile_picture
string

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

Response

200 - application/json
Success
​
description
string
required

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

Example:

"My group description"

​
id
string
required

Identificador único do grupo.

Example:

"120363279776130958"

​
invite_code
string
required

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

Example:

"BobOM8UXL8EDR3dXoKozql"

​
is_announcement
boolean
required

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

Example:

true

​
is_restricted
boolean
required

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

Example:

true

​
name
string
required

O nome dado ao grupo.

Example:

"My group name"

​
owner
object
required
​
profile_picture
string
required

Profile picture URL of the group.

Example:

"https://zapsterapi.s3.us-east-1.amazonaws.com/instances/i-7360mtucxawrpqwxxfll1/profile-pictures/hrs9ncawv3r7euulclfk684dfq9vgi7r.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAV6PM7KXCEFS4IW3T%2F20240526%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240526T235811Z&X-Amz-Expires=86400&X-Amz-Signature=dba5db50b719f5e9454ab8e9fac479c3d6dfa712842886d2da20c36595aab1dc&X-Amz-SignedHeaders=host&x-id=GetObject"

​
total_participants
integer
required

Total number of participants in the group.

Example:

2