vértice
Produto Preços Painel
Grupos

Restringir mensagens/edição e modo de entrada

Restringe quem pode falar (announcement) ou quem pode editar as informações do grupo (locked).

API key Escopo write
Exemplo de requisição
curl -X PATCH "https://seu-dominio/instances/:id/groups/:jid/settings" \
  -H "x-api-key: $VERTICE_API_KEY" \
  -H "content-type: application/json" \
  -d '{"setting":"announcement","memberAddMode":"admin_add","joinApprovalMode":"on"}'
PATCH /instances/{id}/groups/{jid}/settings
API key
Entenda

Conceituação

Restringe quem pode falar (announcement) ou quem pode editar as informações do grupo (locked).

A operação exige que a instância esteja conectada ao WhatsApp. Caso o socket esteja desconectado, a API responde 409 not_connected.

Corpo JSON. Os campos abaixo são exemplos; campos marcados como obrigatórios precisam ser enviados.
Contrato

Atributos

Header

x-api-key string obrigatório

API key do workspace (vtc_live_...). Também aceita Authorization: Bearer.

content-type string obrigatório

application/json.

Path

id string obrigatório

ID da instância.

jid string obrigatório

JID do grupo terminando em @g.us.

Body

setting string obrigatório

announcement, not_announcement, locked ou unlocked.

memberAddMode string opcional

Campo memberAddMode do corpo JSON.

joinApprovalMode string opcional

Campo joinApprovalMode do corpo JSON.

Payload

Request Body

{
  "setting": "announcement",
  "memberAddMode": "admin_add",
  "joinApprovalMode": "on"
}
Contrato

Resposta

200
{
  "data": {
    "ok": true
  }
}

Respostas de sucesso são envelopadas em data.

Erros comuns

400 Corpo, query ou parâmetro inválido. A resposta traz error.code e error.message.
401 Credencial ausente, inválida ou sessão expirada.
403 Escopo insuficiente, IP não autorizado ou workspace suspenso.
404 Recurso não encontrado ou pertence a outro workspace.
409 Instância não conectada ou conflito de estado.