Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
update-group-settings
Configurações do grupo
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/update-group-settings \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "adminOnlyMessage": true,
  "adminOnlySettings": true,
  "requireAdminApproval": true,
  "adminOnlyAddMember": true
}
'

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Este método permite você alterar as preferências do grupo.
Somente administradores podem alterar as preferências do grupo.

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Obrigatórios

​
phone
string
obrigatório
ID/Phone do grupo
​
adminOnlyMessage
boolean
obrigatório
Apenas administradores podem enviar mensagens
​
adminOnlySettings
boolean
obrigatório
Apenas administradores podem alterar configurações do grupo
​
requireAdminApproval
boolean
obrigatório
Aprovação de administrador necessária para novos membros
​
adminOnlyAddMember
boolean
obrigatório
Apenas administradores podem adicionar membros

​
Request Body

{
  "phone": "120363019502650977-group",
  "adminOnlyMessage": true,
  "adminOnlySettings": true,
  "requireAdminApproval": false,
  "adminOnlyAddMember": true
}

​
Response

​
200

{
  "value": true
}

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.