vértice
Produto Preços Painel
Grupos

Revogar e gerar um novo link

Revoga o link atual e gera um novo código de convite.

API key Escopo write
Exemplo de requisição
curl -X POST "https://seu-dominio/instances/:id/groups/:jid/invite/revoke" \
  -H "x-api-key: $VERTICE_API_KEY"
POST /instances/{id}/groups/{jid}/invite/revoke
API key
Entenda

Conceituação

Revoga o link atual e gera um novo código de convite.

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

Contrato

Atributos

Header

x-api-key string obrigatório

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

Path

id string obrigatório

ID da instância.

jid string obrigatório

JID do grupo terminando em @g.us.

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.