Skip to main content
GET
/
api
/
profile
/
getPrivacy
/
:instance
Check privacy
curl --request GET \
  --url https://api.example.com/api/profile/getPrivacy/:instance \
  --header 'token: <token>'

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Auth: TokenAccount or TokenInstance • Rate limit: Global (100/min) • Idempotent: yes (read-only)

​
Description

Returns all privacy settings of the connected account, grouped into three sub-objects: visibility, privacy, and permissions.

​
Examples

​
Default

Reads the complete privacy snapshot of the account, grouped into visibility, privacy, and permissions. No query parameters or body, a simple read to check the current state before calling the corresponding POST. 
curl -X GET "https://ryzeapi.cloud/api/profile/getPrivacy/$Instance_Name" \
  -H "token: $Token_Instance"

​
Success response

Returns the complete privacy snapshot in settings, grouped into three sub-objects: visibility (lastSeen, status, profile, online), privacy (readReceipts), and permissions (callAdd, groupAdd). Values come from the local store synced via appstate, changes made in the official app may take a few seconds to reflect here.
200 OK
{
  "success": true,
  "message": "Privacy settings retrieved successfully",
  "settings": {
    "visibility": {
      "lastSeen": "contacts",
      "status": "all",
      "profile": "contacts",
      "online": "match_last_seen"
    },
    "privacy": {
      "readReceipts": "all"
    },
    "permissions": {
      "callAdd": "all",
      "groupAdd": "contacts"
    }
  }
}

​
Path parameters

​
instance
string
required
Instance name.

​
Headers

​
token
string
required
TokenAccount or TokenInstance.

​
Accepted values

FieldValues
lastSeen / status / profileall / contacts / contact_blacklist / none
onlineall / match_last_seen
readReceiptsall / none
callAddall / known
groupAddall / contacts / contact_blacklist

​
Notes

  • Values come primarily from the local whatsmeow store, synced via appstate. Changes made in the official app appear here with a few seconds of latency.
  • online: match_last_seen means your online presence follows the lastSeen rule, if lastSeen=none, no one sees you online either.
  • Defaults for newly created accounts: everything set to all.

​
Errors

HTTPMessage
400Instance is not connected to WhatsApp
404Instance not found
Envelope: 
{
  "success": false,
  "error": { "message": "Instance is not connected to WhatsApp" }
}