vértice
Produto Preços Painel
Privacidade

Atualizar privacidade do número

Altera último acesso, foto, recado, online, confirmações, grupos, chamadas, mensagens e desaparecimento.

API key Escopo write
Exemplo de requisição
curl -X PATCH "https://seu-dominio/instances/:id/privacy" \
  -H "x-api-key: $VERTICE_API_KEY" \
  -H "content-type: application/json" \
  -d '{"lastSeen":"contacts","profilePhoto":"contacts","readReceipts":"all","groupsAdd":"contacts","calls":"known"}'
PATCH /instances/{id}/privacy
API key
Entenda

Conceituação

Altera último acesso, foto, recado, online, confirmações, grupos, chamadas, mensagens e desaparecimento.

Respostas de sucesso seguem { "data": ... }; erros seguem { "error": { "code", "message" } }. Operações de escrita exigem escopo write quando autenticadas por API key.

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.

Body

lastSeen string opcional

Campo lastSeen do corpo JSON.

profilePhoto string opcional

Campo profilePhoto do corpo JSON.

readReceipts string opcional

Campo readReceipts do corpo JSON.

groupsAdd string opcional

Campo groupsAdd do corpo JSON.

calls string opcional

Campo calls do corpo JSON.

Payload

Request Body

{
  "lastSeen": "contacts",
  "profilePhoto": "contacts",
  "readReceipts": "all",
  "groupsAdd": "contacts",
  "calls": "known"
}
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.