Skip to main content
POST
/
api
/
alertmonitoring
/
createCustomPinForLocation
Create custom PIN for location
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"
}
'
{
  "alreadyExists": false,
  "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 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