story

[BETA] get the current Status privacy

Retrieve the current Status privacy setting for the instance. Returns the audience type ("contact" for all contacts, "allow-list" for an allowlist, "deny-list" for a denylist) and the configured contacts (when type is allow-list or deny-list). Note: This endpoint is currently in beta and may change without notice.

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

Request

  • Base URL: https://waapi.app/api/v1
  • URL: https://waapi.app/api/v1/instances/{id}/client/action/get-status-privacy
  • 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: Status privacy 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

{
  "status": "success",
  "data": {
    "status": "success",
    "data": {
      "setting": "allow-list",
      "contacts": [
        "491234567890@c.us"
      ]
    }
  },
  "links": {
    "self": "https://waapi.app/api/v1/instances/1/client/action/get-status-privacy"
  }
}

Changes

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