Configurações da comunidade
setting aceita locked/unlocked como entrada, mas o WhatsApp pode rejeitar configurações no nó pai: HTTP422/community_setting_rejected (403 para permissão negada).
curl -X PATCH "https://seu-dominio/instances/:id/communities/:jid/settings" \
-H "x-api-key: $VERTICE_API_KEY" \
-H "content-type: application/json" \
-d '{"setting":"locked"}'const response = await fetch('https://seu-dominio/instances/:id/communities/:jid/settings', {
method: 'PATCH',
headers: {
'x-api-key': process.env.VERTICE_API_KEY ?? '',
'content-type': 'application/json',
},
body: JSON.stringify({
"setting": "locked"
}),
});
const payload = await response.json();
console.log(payload);Conceituação
setting aceita locked/unlocked como entrada, mas o WhatsApp pode rejeitar configurações no nó pai: HTTP422/community_setting_rejected (403 para permissão negada). announcement/not_announcement pertencem ao grupo de anúncios. Valida todos os campos antes das operações e informa quantas alterações foram aplicadas antes de uma recusa; não há rollback nativo.
Respostas de sucesso seguem { "data": ... }; erros seguem { "error": { "code", "message" } }. Operações de escrita exigem escopo write quando autenticadas por API key.
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
opcional
announcement, not_announcement, locked ou unlocked.
Request Body
{
"setting": "locked"
}Resposta
{
"data": {
"ok": true
}
}Respostas de sucesso são envelopadas em data.