Update keypad

Update keypad settings

POST /api/keypad/updateKeypad

Update keypad

cURL

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": "[phone]",
  "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",
  "subLocationsHierarchyKeyUpdated": false,
  "timeZoneId": "America/Los_Angeles",
  "videoWallUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

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 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:

"[phone]"

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

Show child attributes

showCallBuildingAdmin · boolean | null

Whether to show the call building admin option

Example:

true

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

Whether the sub-locations hierarchy key has been updated

Example:

false

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