Sign in

v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB
client

[BETA] set privacy setting

Update a single privacy category. Allowed values depend on the category. Note: This endpoint is currently in beta and may change without notice.

post/instances/{id}/client/action/set-privacy-setting

Path parameters

idinteger required

Instance ID

Request body

category'readReceipts' | 'lastSeen' | 'online' | 'profilePicture' | 'about' | 'groupAdd' | 'callAdd' | 'messages' required
valuestring required

Allowed values: all, contacts, contact_blacklist, none, known, match_last_seen

disallowedListstring[]

Required only when value is "contact_blacklist".

Response

Privacy setting updated successfully

instanceIdstring

ID of the instance

status'success' | 'error'

Example response

{
  "instanceId": "1",
  "status": "success"
}