Alarm Monitoring Keypad

Update keypad

Update keypad settings

POST/api/keypad/updateKeypad

Authorizations

x-auth-apikeystringheaderrequired

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

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the write scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

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

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

Request object for updating keypad settings and configuration.

additionalFeaturesDisabledboolean | nullbody

armCountdownSecsinteger<int32> | nullbody

Arm countdown seconds for the keypad

Example: 30

buildingAdminPhoneNumberstring | nullbody

Phone number of the building administrator

Example: "+1-555-123-4567"

floorNumberinteger<int32> | nullbody

Floor number where the keypad is located

Example: 1

keypadUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

latitudenumber<double> | nullbody

Latitude coordinate of the keypad location

Example: 37.7749

locationNamestring | nullbody

Name of the location where the keypad is installed

Example: "Main Building"

locationUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

logoUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

longitudenumber<double> | nullbody

Longitude coordinate of the keypad location

Example: -122.4194

namestring | nullbody

Name of the keypad

Example: "Main Entrance Keypad"

qualifiedAddressobjectbody

Qualified address information for the keypad location

Show child attributes

addressLine2string | nullbody

apt, suite, or unit

addressline1string | nullbody

street address

administrativeAreastring | nullbody

state

localitystring | nullbody

city

postalCodestring | nullbody

zip code

regionCodestring | nullbody

country

showCallBuildingAdminboolean | nullbody

Whether to show the call building admin option

Example: true

subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | nullbody

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"

subLocationsHierarchyKeyUpdatedboolean | nullbody

Whether the sub-locations hierarchy key has been updated

Example: false

timeZoneIdstring | nullbody

Time zone ID for the keypad location

Example: "America/Los_Angeles"

videoWallUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

videoWallUuidUpdatedboolean | nullbody

Whether the video wall UUID has been updated

Example: false

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/keypad/updateKeypad' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --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",
    "subLocationsHierarchyKeyUpdated": false,
    "timeZoneId": "America/Los_Angeles",
    "videoWallUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "videoWallUuidUpdated": false
  }'

import requests

url = "https://api2.rhombussystems.com/api/keypad/updateKeypad"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "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",
    "subLocationsHierarchyKeyUpdated": False,
    "timeZoneId": "America/Los_Angeles",
    "videoWallUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "videoWallUuidUpdated": False
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/keypad/updateKeypad', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "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",
    "subLocationsHierarchyKeyUpdated": false,
    "timeZoneId": "America/Los_Angeles",
    "videoWallUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "videoWallUuidUpdated": false
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "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",
              "subLocationsHierarchyKeyUpdated": false,
              "timeZoneId": "America/Los_Angeles",
              "videoWallUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "videoWallUuidUpdated": false
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/keypad/updateKeypad"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "error": false,
  "errorCode": "<string>"
}

Response

200 OK

application/json · object

Response object for updating keypad settings.

errorboolean | null

errorCodestring | null

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring | null

warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.