story

[BETA] set the Status privacy

Configure who can see Status posts from this instance. Set type to "all" for all contacts, "allow" to restrict visibility to a specific list of contacts, or "deny" to exclude specific contacts. ⚠️ This is a persistent account-level setting and is synchronized to all linked devices. Note: This endpoint is currently in beta and may change without notice.

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

Request

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

Path parameters

idinteger required

Instance ID

Request body

type'all' | 'allow' | 'deny' required

"all" shows the Status to all contacts; "allow" restricts visibility to the listed contacts; "deny" excludes the listed contacts.

contactsstring[]

E.164 phone numbers or chat IDs. Required when type is "allow" or "deny".

Example request

{
  "type": "allow",
  "contacts": [
    "+491234567890",
    "491234567891@c.us"
  ]
}

Response

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

{
  "status": "success",
  "data": {
    "status": "success",
    "data": {
      "updated": true,
      "type": "allow",
      "contactCount": 2
    }
  },
  "links": {
    "self": "https://waapi.app/api/v1/instances/1/client/action/set-status-privacy"
  }
}

Changes

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