client

[BETA] get privacy settings

Retrieve the authenticated account's privacy settings. Note: This endpoint is currently in beta and may change without notice.

post/instances/{id}/client/action/get-privacy-settings

Request

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

Path parameters

idinteger required

Instance ID

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Privacy settings retrieved 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.