Pular para o conteúdo principal

Configurações do grupo

Método#

/update-group-settings#

POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/update-group-settings

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

Conceituação#

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

Atenção

Atenção somente administradores podem alterar as preferências do grupo.

Atenção

No dia 4 de novembro de 2021 o whatsapp alterou a formato da criação de novos grupos, antes: "phone": "5511999999999-1623281429" agora: "phone": "120363019502650977-group"


Atributos#

Obrigatórios#

AtributosTipoDescrição
phonestringID/Fone do grupo
adminOnlyMessagebooleanSomente administradores podem enviar mensagens no grupo
adminOnlySettingsbooleanAtributo para permitir que apenas os admins façam edições no grupo
requireAdminApprovalbooleanDefine se vai ser necessário a aprovação de algum admin para entrar no grupo
adminOnlyAddMemberbooleanSomente administradores podem adicionar pessoas no grupo

Request Body#

Forma antiga -
{
"phone": "5511999999999-1623281429",
"adminOnlyMessage": true,
"adminOnlySettings": true,
"requireAdminApproval": false,
"adminOnlyAddMember": true
}
----------------------------------------
Forma nova -
{
"phone": "120363019502650977-group",
"adminOnlyMessage": true,
"adminOnlySettings": true,
"requireAdminApproval": false,
"adminOnlyAddMember": true
}

Response#

200#

AtributosTipoDescrição
valuebooleantrue caso tenha dado certo e false em caso de falha

Exemplo

{
"value": true
}

405#

Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no inicio 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"


Webhook Response#

Link para a response do webhook (ao receber)

Webhook


Code#