Skip to main content
POST
/
api
/
keypad
/
claimKeypadActivationToken
Claim keypad activation token
curl --request POST \
  --url https://api2.rhombussystems.com/api/keypad/claimKeypadActivationToken \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "activationToken": "act_token_12345",
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "name": "Main Entrance Keypad",
  "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.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 claiming a keypad activation token to connect a keypad to Rhombus services.

​
activationToken
string | null

Activation token for claiming the keypad

Example:

"act_token_12345"

​
locationUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

​
name
string | null

Name for the keypad

Example:

"Main Entrance Keypad"

​
subLocationsHierarchyKey
object

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

Example:

"AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object for claiming a keypad activation token.

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