Sign in

v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB
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

Path parameters

idinteger required

Instance ID

Response

Status privacy retrieved successfully

status'success' | 'error'
instanceIdstring

Example response

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