/bff/presence/entity-touch

Stamps the caller as currently viewing the (entity, entityCode) pair and returns the list of recent viewers from the same organisation. Intended to be polled by the admin UI every ~10 s while a member has an entity detail open.

PresencepostBffPresenceEntity-touch

Parameters

JSON body

Request body

application/json

entitystringRequired

Entity type code, e.g. "order".

Length: 1–32

entityCodestringRequired

Public identifier of the entity (hash/slug/code).

Length: 1–255

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json

{
  "success": true
}

Request example

POST /bff/presence/entity-touch

post

curl -X POST "https://api.bizkithub.com/bff/presence/entity-touch" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "entity": "example_entity",
  "entityCode": "example_entityCode"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key