Skip to main content
POST
/
api
/
keypad
/
updateKeypad
Update keypad
curl --request POST \
  --url https://api2.rhombussystems.com/api/keypad/updateKeypad \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "additionalFeaturesDisabled": true,
  "armCountdownSecs": 30,
  "buildingAdminPhoneNumber": "+1-555-123-4567",
  "floorNumber": 1,
  "keypadUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "latitude": 37.7749,
  "locationName": "Main Building",
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "logoUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "longitude": -122.4194,
  "name": "Main Entrance Keypad",
  "qualifiedAddress": {
    "addressLine2": "<string>",
    "addressline1": "<string>",
    "administrativeArea": "<string>",
    "locality": "<string>",
    "postalCode": "<string>",
    "regionCode": "<string>"
  },
  "showCallBuildingAdmin": true,
  "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
  "timeZoneId": "America/Los_Angeles",
  "videoWallUuid": "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 object for updating keypad settings and configuration.

​
additionalFeaturesDisabled
boolean | null
​
armCountdownSecs
integer<int32> | null

Arm countdown seconds for the keypad

Example:

30

​
buildingAdminPhoneNumber
string | null

Phone number of the building administrator

Example:

"+1-555-123-4567"

​
floorNumber
integer<int32> | null

Floor number where the keypad is located

Example:

1

​
keypadUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

​
latitude
number<double> | null

Latitude coordinate of the keypad location

Example:

37.7749

​
locationName
string | null

Name of the location where the keypad is installed

Example:

"Main Building"

​
locationUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

​
logoUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

​
longitude
number<double> | null

Longitude coordinate of the keypad location

Example:

-122.4194

​
name
string | null

Name of the keypad

Example:

"Main Entrance Keypad"

​
qualifiedAddress
object

Qualified address information for the keypad location

​
showCallBuildingAdmin
boolean | null

Whether to show the call building admin option

Example:

true

​
subLocationsHierarchyKey
object

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

Example:

"AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

​
timeZoneId
string | null

Time zone ID for the keypad location

Example:

"America/Los_Angeles"

​
videoWallUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object for updating keypad settings.

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