Skip to main content
POST
Create custom PIN for location

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
RUUID

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
Last modified on August 3, 2026