Skip to main content
GET
/
status
/
privacy
Get status privacy settings
curl --request GET \
  --url https://api.wsapi.chat/status/privacy \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Instance-Id: <x-instance-id>'
[
  {
    "type": "contacts",
    "list": [],
    "isDefault": true
  }
]

Authorizations

​
X-Api-Key
string
header
required

Instance or customer-level API key. Either the instance's own API key or the customer's API key is accepted. Must be paired with the X-Instance-Id header to identify the target instance.

Headers

​
X-Instance-Id
string
default:{{instanceId}}
required

The ID of the WhatsApp instance to use

Response

Status privacy settings

​
type
enum<string>

Privacy setting type

Available options:
contacts,
blacklist,
whitelist
​
list
string[]

List of JIDs included in the privacy setting

​
isDefault
boolean

Whether this is the default privacy setting