Skip to main content
POST
Selective update prompt configuration

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 selectively updating a prompt configuration.

active
boolean | null

Optional active status for the prompt configuration

cameraConfigurations
object[] | null

List of camera configurations for the prompt

checkCondition
object | null
description
string | null

Optional description for the prompt configuration

minuteTriggerRate
integer<int32> | null
int32

Optional minute trigger rate for the configuration

name
string | null

Optional name for the prompt configuration

orgUuid
string<RUUID> | null
RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

prompt
string | null

Optional prompt text for the configuration

promptType
enum<string>

Optional prompt type for the configuration

Available options:
COUNT,
PERCENT,
BOOLEAN,
TEXT
scheduleUuid
string<RUUID> | null
RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

shortName
string | null

Optional short name for the prompt configuration

uuid
string<RUUID> | null
RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object for selectively updating a prompt configuration.

error
boolean | null
errorMsg
string | null
warningMsg
string | null
Last modified on July 24, 2026