Create custom PIN for location

Create a custom PIN for alert monitoring at a specific location.

POST /api/alertmonitoring/createCustomPinForLocation

Create custom PIN for location

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/alertmonitoring/createCustomPinForLocation \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "description": "Custom PIN for main entrance access",
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "name": "Custom Main Entrance PIN",
  "pin": "5678"
}
'

200

{
  "alreadyExists": false,
  "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 to create a custom PIN for alert monitoring at a specific location.

description · string | null

Description of the PIN

Example:

"Custom PIN for main entrance access"

locationUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

name · string | null

Name for the PIN

Example:

"Custom Main Entrance PIN"

pin · string | null

Custom PIN code to be created

Example:

"5678"

Response

200 - application/json

OK

Response indicating the result of creating a custom PIN for alert monitoring.

alreadyExists · boolean | null

Indicates whether the PIN already exists

Example:

false

error · boolean | null

errorMsg · string | null

warningMsg · string | null