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

Request

  • Base URL: https://waapi.app/api/v1
  • URL: https://waapi.app/api/v1/instances/{id}/client/action/set-privacy-setting
  • Auth: HTTP bearer

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

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Privacy setting updated successfully.

status'success' | 'error'

Whether the request reached the instance. success here does not mean the action was carried out — that is reported by data.status, which is the authoritative one. A malformed input arrives as status: success with data.status: error.

Example response

{
  "data": {
    "status": "success"
  },
  "status": "success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.