Skip to main content
POST
/
api
/
button
/
updateDetails
Update button details
curl --request POST \
  --url https://api2.rhombussystems.com/api/button/updateDetails \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "associatedCameras": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "buttonMode": "PANIC",
  "description": "<string>",
  "floorNumber": 1,
  "latitude": 37.7749,
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "longitude": -122.4194,
  "name": "<string>",
  "sensorUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

​
x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

​
x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request to update button sensor details.

​
associatedCameras
(string<DeviceFacetUuid> | null)[] | null

List of associated camera device UUIDs

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

​
buttonMode
enum<string>

Optional button mode configuration

Available options:
PANIC,
PROGRAMMABLE,
DOORBELL,
NONE
​
description
string | null

Optional description for the button sensor

​
floorNumber
integer<int32> | null

Optional floor number

Example:

1

​
latitude
number<double> | null

Optional latitude coordinate

Example:

37.7749

​
locationUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

​
longitude
number<double> | null

Optional longitude coordinate

Example:

-122.4194

​
name
string | null

Optional name for the button sensor

​
sensorUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

​
error
boolean | null
​
errorMsg
string | null
​
warningMsg
string | null