updateSiteVBeacon
Update Site Virtual Beacon
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
uuiduuidRequest Body
application/json
Request Body
Virtual beacon configuration for SDK proximity notifications
Bluetooth beacon major value used for proximity matching
Floorplan map identifier containing the virtual beacon
uuidNotification message displayed by the SDK application when a client is near the virtual beacon
Bluetooth beacon minor value used for proximity matching
Display name or label for the virtual beacon
Required if power_mode==custom, -30 - 100, in dBm. For default power_mode, power = 4 dBm.
-30 <= value <= 1004Transmit power mode for the virtual beacon. enum: custom, default.
"default"Value in
- "custom"
- "default"
Destination URL shown by the SDK application when a client is near the virtual beacon
Bluetooth beacon UUID used for proximity matching
uuidName to be used in wayfinding_path or wayfinding_grid blob
Horizontal pixel coordinate of the virtual beacon on the map
doubleVertical pixel coordinate of the virtual beacon on the map
doubleResponse Body
curl -X PUT "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/vbeacons/000000ab-00ab-00ab-00ab-0000000000ab" \ -H "Content-Type: application/json" \ -d '{ "major": 0, "message": "string", "minor": 0, "name": "string", "power": 4, "power_mode": "default", "url": "string", "uuid": "6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9", "wayfinding_nodename": "string", "x": 0, "y": 0 }'{ "created_time": 0, "id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1", "major": 0, "map_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1", "message": "string", "minor": 0, "modified_time": 0, "name": "string", "org_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1", "power": 4, "power_mode": "default", "site_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1", "url": "string", "uuid": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1", "wayfinding_nodename": "string", "x": 0, "y": 0}