Skip to main content
POST
/
api
/
relay
/
updateDetailsV2
Update NVR details V2
curl --request POST \
  --url https://api2.rhombussystems.com/api/relay/updateDetailsV2 \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "description": "Primary NVR for main building",
  "descriptionUpdated": true,
  "directionRadians": 123,
  "directionRadiansUpdated": true,
  "floorNumber": 123,
  "floorNumberUpdated": true,
  "latitude": 123,
  "latitudeUpdated": true,
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "locationUuidUpdated": true,
  "longitude": 123,
  "longitudeUpdated": true,
  "name": "Main NVR",
  "nameUpdated": true,
  "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
  "subLocationsHierarchyKeyUpdated": true,
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.rhombus.community/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-auth-apikey
string
header
required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

​
x-auth-scheme
enum<string>
default:api-token
required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options:
api-token,
api,
partner-api-token,
partner-api

Body

application/json

Request object for updating NVR details.

​
description
string | null

Description of the NVR

Example:

"Primary NVR for main building"

​
descriptionUpdated
boolean | null
​
directionRadians
number<float> | null
​
directionRadiansUpdated
boolean | null
​
floorNumber
integer<int32> | null
​
floorNumberUpdated
boolean | null
​
latitude
number<double> | null
​
latitudeUpdated
boolean | null
​
locationUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

​
locationUuidUpdated
boolean | null
​
longitude
number<double> | null
​
longitudeUpdated
boolean | null
​
name
string | null

Name of the NVR

Example:

"Main NVR"

​
nameUpdated
boolean | null
​
policyUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

​
subLocationsHierarchyKey
string<SubLocationsHierarchyKey> | null

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$
Example:

"AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

​
subLocationsHierarchyKeyUpdated
boolean | null
​
uuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object for updating NVR details.

​
error
boolean | null
​
errorMsg
string | null
​
warningMsg
string | null
Last modified on May 20, 2026