Atualizar privacidade

POST

api

profile

privacy

:instance

Atualizar privacidade

curl --request POST \
  --url https://api.example.com/api/profile/privacy/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "visibility": {},
  "privacy": {},
  "permissions": {}
}
'

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({visibility: {}, privacy: {}, permissions: {}})
};

fetch('https://api.example.com/api/profile/privacy/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/profile/privacy/:instance"

payload = {
    "visibility": {},
    "privacy": {},
    "permissions": {}
}
headers = {
    "token": "<token>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Auth: TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim (setar o mesmo valor e no-op)

Descrição

Atualiza uma ou mais configurações de privacidade. Update parcial, apenas os campos enviados são alterados. Pelo menos uma das três subseções (visibility, privacy, permissions) precisa ser enviada. A resposta retorna as configurações completas após o update.

Exemplos

Tudo restritivo

Aplica um perfil de privacidade fechado em uma única chamada: esconde lastSeen, restringe status / foto a contatos, desliga read receipts e limita chamadas a contatos conhecidos. Cada subseção envia um campo, totalizando várias stanzas no WhatsApp.

curl -X POST "https://ryzeapi.cloud/api/profile/privacy/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "visibility": {
      "lastSeen": "none",
      "status": "contacts",
      "profile": "contacts",
      "online": "match_last_seen"
    },
    "privacy": {
      "readReceipts": "none"
    },
    "permissions": {
      "callAdd": "known",
      "groupAdd": "contacts"
    }
  }'

await fetch(`https://ryzeapi.cloud/api/profile/privacy/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    visibility: {
      lastSeen: "none",
      status:   "contacts",
      profile:  "contacts",
      online:   "match_last_seen"
    },
    privacy: {
      readReceipts: "none"
    },
    permissions: {
      callAdd:  "known",
      groupAdd: "contacts"
    }
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/profile/privacy/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "visibility": {
            "lastSeen": "none",
            "status":   "contacts",
            "profile":  "contacts",
            "online":   "match_last_seen"
        },
        "privacy": {
            "readReceipts": "none"
        },
        "permissions": {
            "callAdd":  "known",
            "groupAdd": "contacts"
        }
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "visibility": {
            "lastSeen": "none",
            "status":   "contacts",
            "profile":  "contacts",
            "online":   "match_last_seen"
        },
        "privacy": {
            "readReceipts": "none"
        },
        "permissions": {
            "callAdd":  "known",
            "groupAdd": "contacts"
        }
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/profile/privacy/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Só groupAdd

Atualiza somente permissions.groupAdd para contacts, impedindo que desconhecidos adicionem a conta a grupos. As demais configurações ficam inalteradas.

curl -X POST "https://ryzeapi.cloud/api/profile/privacy/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "permissions": { "groupAdd": "contacts" }
  }'

await fetch(`https://ryzeapi.cloud/api/profile/privacy/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    permissions: { groupAdd: "contacts" }
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/profile/privacy/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "permissions": {"groupAdd": "contacts"}
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "permissions": { "groupAdd": "contacts" }
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/profile/privacy/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Desligar read receipts

Define privacy.readReceipts como none para parar de enviar o “duplo check azul”. A conta deixa de confirmar leitura, e também deixa de ver a confirmação dos outros (efeito recíproco do WhatsApp).

curl -X POST "https://ryzeapi.cloud/api/profile/privacy/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "privacy": { "readReceipts": "none" }
  }'

await fetch(`https://ryzeapi.cloud/api/profile/privacy/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    privacy: { readReceipts: "none" }
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/profile/privacy/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "privacy": {"readReceipts": "none"}
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "privacy": { "readReceipts": "none" }
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/profile/privacy/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Apenas lastSeen e online

Esconde o lastSeen e amarra o online ao mesmo nível (match_last_seen). Resultado: ninguém vê quando a conta esteve online pela última vez nem se ela está ativa agora.

curl -X POST "https://ryzeapi.cloud/api/profile/privacy/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "visibility": {
      "lastSeen": "none",
      "online": "match_last_seen"
    }
  }'

await fetch(`https://ryzeapi.cloud/api/profile/privacy/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    visibility: {
      lastSeen: "none",
      online:   "match_last_seen"
    }
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/profile/privacy/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "visibility": {
            "lastSeen": "none",
            "online":   "match_last_seen"
        }
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "visibility": {
            "lastSeen": "none",
            "online":   "match_last_seen"
        }
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/profile/privacy/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Resposta de sucesso

Após aplicar os updates, o handler refaz um GetPrivacySettings e devolve o snapshot completo atual em settings, agrupado em visibility (lastSeen, status, profile, online), privacy (readReceipts) e permissions (callAdd, groupAdd). Use o response como fonte da verdade do estado pós-update, é o que o WhatsApp confirmou, não apenas o que você enviou.

200 OK

{
  "success": true,
  "message": "Privacy settings updated successfully",
  "settings": {
    "visibility": {
      "lastSeen": "none",
      "status": "contacts",
      "profile": "contacts",
      "online": "match_last_seen"
    },
    "privacy": {
      "readReceipts": "none"
    },
    "permissions": {
      "callAdd": "known",
      "groupAdd": "contacts"
    }
  }
}

Parâmetros de rota

string

obrigatório

Nome da instância.

Headers

string

obrigatório

TokenAccount ou TokenInstance.

string

obrigatório

application/json

Request body

Cada subseção é opcional, mas pelo menos uma deve estar presente.

object

Subcampos: lastSeen, status, profile, online.

object

Subcampos: readReceipts.

object

Subcampos: callAdd, groupAdd.

Valores aceitos por campo

Campo	Valores
`lastSeen` / `status` / `profile`	`all` / `contacts` / `contact_blacklist` / `none`
`online`	`all` / `match_last_seen`
`readReceipts`	`all` / `none`
`callAdd`	`all` / `known`
`groupAdd`	`all` / `contacts` / `contact_blacklist`

Notas

Validação para antes do primeiro erro. Se você envia visibility.lastSeen = "X" (inválido) + visibility.status = "contacts" (válido), nada é aplicado, o handler aborta no primeiro campo inválido. Valide enums no cliente antes de chamar.

Operações não são transacionais: se o terceiro SetPrivacySetting falhar, os dois primeiros já foram aplicados, o cliente recebe 500 mas o estado parcial persiste. Verifique via GET após erros.
Cada campo dispara uma stanza separada, um update com 7 campos faz 7 chamadas + 1 GetPrivacySettings final = 8 stanzas. Pode somar latência.
O response sempre traz as configurações completas atuais (não só os campos alterados).

Erros

HTTP	Mensagem
400	`At least one privacy setting must be provided`
400	`Invalid lastSeen value: <value>. Valid values: all, contacts, contact_blacklist, none`
400	`Invalid status value: <value>. Valid values: all, contacts, contact_blacklist, none`
400	`Invalid profile value: <value>. Valid values: all, contacts, contact_blacklist, none`
400	`Invalid online value: <value>. Valid values: all, match_last_seen`
400	`Invalid readReceipts value: <value>. Valid values: all, none`
400	`Invalid callAdd value: <value>. Valid values: all, known`
400	`Invalid groupAdd value: <value>. Valid values: all, contacts, contact_blacklist`
400	`Instance is not connected to WhatsApp`
500	`failed to update <field> privacy: <reason>`

Envelope:

{
  "success": false,
  "error": { "message": "Invalid lastSeen value: everyone. Valid values: all, contacts, contact_blacklist, none" }
}

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Atualizar privacidade

Descrição

Exemplos

Tudo restritivo

Só groupAdd

Desligar read receipts

Apenas lastSeen e online

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Valores aceitos por campo

Notas

Erros

​Descrição

​Exemplos

​Tudo restritivo

​Só groupAdd

​Desligar read receipts

​Apenas lastSeen e online

​Resposta de sucesso

​Parâmetros de rota

​Headers

​Request body

​Valores aceitos por campo

​Notas

​Erros

Descrição

Exemplos

Tudo restritivo

Só groupAdd

Desligar read receipts

Apenas lastSeen e online

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Valores aceitos por campo

Notas

Erros