Update rule
curl --request POST \
--url https://api2.rhombussystems.com/api/rules/updateRule \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"ruleUpdate": {
"action": {
"activateLocationLockdown": {
"locationLockdownPlanUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA"
},
"alertAction": true,
"audioPlaybackActions": [
{
"audioClipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"audioGateways": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"loopDurationSec": 123,
"playCount": 123
}
],
"cancelLoopingAudioPlaybackAction": {
"_audioDevices": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"audioDevices": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
]
},
"changeComponentCompositeAccessStateActions": [
{
"alwaysCreateOverrideIfNoFirstIn": true,
"componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"expireTimeDelaySeconds": 123,
"expireTimeOfDayLocalSeconds": 123,
"useFirstInRulesIfPossible": true
}
],
"connectAudioDeviceToPhoneNumberAction": {
"audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"doorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"optionalGreeting": "<string>",
"phoneNumber": "<string>"
},
"customActions": [
{
"headers": {},
"path": "<string>"
}
],
"customLLMActions": [
{
"deviceActivityEvents": {},
"deviceFacetUuids": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"promptUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"timestampMs": 123
}
],
"enableDisableAudioRecordActions": [
{
"audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"enable": true
}
],
"integrationCommandActions": [
{
"commandPayload": "<string>",
"delaySecs": 123
}
],
"integrationNotificationActions": [
{
"notificationEntity": "<string>",
"notificationTarget": "<string>"
}
],
"liveNotificationAction": true,
"remoteDoorUnlockActions": [
{
"doorId": "<string>",
"placeId": "<string>"
}
],
"robotActions": [
{
"mapUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"pose": {
"orientation": [
123
],
"position": [
123
]
},
"routeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"waypointUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"thirdPartyAudioPlaybackAction": {
"audioFileName": "<string>",
"ipAddress": "<string>",
"loopDurationSec": 123,
"password": "<string>",
"playCount": 123,
"proxyDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"username": "<string>"
},
"triggerComponentRelayActions": [
{
"componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"overrideRelayDurationMs": 123,
"overrideRelayDurationSec": 123,
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"webhookActions": [
{
"headers": {},
"oauthClientId": "<string>",
"oauthClientSecret": "<string>",
"oauthGrantType": "<string>",
"oauthScope": "<string>",
"oauthUrl": "<string>",
"webhookUrl": "<string>"
}
]
},
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ownerUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ruleFilters": {
"scheduleUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"triggerBackoffSecs": 123
},
"triggers": [
{
"activityEvent": {},
"componentCompositeUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"componentUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"deviceLabels": [
"<string>"
],
"deviceUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"locationUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
}
],
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
}
'{
"error": true,
"errorMsg": "<string>",
"warningMsg": "<string>"
}Update rule
Update a rule
POST
/
api
/
rules
/
updateRule
Update rule
curl --request POST \
--url https://api2.rhombussystems.com/api/rules/updateRule \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"ruleUpdate": {
"action": {
"activateLocationLockdown": {
"locationLockdownPlanUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA"
},
"alertAction": true,
"audioPlaybackActions": [
{
"audioClipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"audioGateways": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"loopDurationSec": 123,
"playCount": 123
}
],
"cancelLoopingAudioPlaybackAction": {
"_audioDevices": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"audioDevices": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
]
},
"changeComponentCompositeAccessStateActions": [
{
"alwaysCreateOverrideIfNoFirstIn": true,
"componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"expireTimeDelaySeconds": 123,
"expireTimeOfDayLocalSeconds": 123,
"useFirstInRulesIfPossible": true
}
],
"connectAudioDeviceToPhoneNumberAction": {
"audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"doorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"optionalGreeting": "<string>",
"phoneNumber": "<string>"
},
"customActions": [
{
"headers": {},
"path": "<string>"
}
],
"customLLMActions": [
{
"deviceActivityEvents": {},
"deviceFacetUuids": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"promptUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"timestampMs": 123
}
],
"enableDisableAudioRecordActions": [
{
"audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"enable": true
}
],
"integrationCommandActions": [
{
"commandPayload": "<string>",
"delaySecs": 123
}
],
"integrationNotificationActions": [
{
"notificationEntity": "<string>",
"notificationTarget": "<string>"
}
],
"liveNotificationAction": true,
"remoteDoorUnlockActions": [
{
"doorId": "<string>",
"placeId": "<string>"
}
],
"robotActions": [
{
"mapUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"pose": {
"orientation": [
123
],
"position": [
123
]
},
"routeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"waypointUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"thirdPartyAudioPlaybackAction": {
"audioFileName": "<string>",
"ipAddress": "<string>",
"loopDurationSec": 123,
"password": "<string>",
"playCount": 123,
"proxyDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"username": "<string>"
},
"triggerComponentRelayActions": [
{
"componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"overrideRelayDurationMs": 123,
"overrideRelayDurationSec": 123,
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"webhookActions": [
{
"headers": {},
"oauthClientId": "<string>",
"oauthClientSecret": "<string>",
"oauthGrantType": "<string>",
"oauthScope": "<string>",
"oauthUrl": "<string>",
"webhookUrl": "<string>"
}
]
},
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ownerUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ruleFilters": {
"scheduleUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"triggerBackoffSecs": 123
},
"triggers": [
{
"activityEvent": {},
"componentCompositeUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"componentUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"deviceLabels": [
"<string>"
],
"deviceUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"locationUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
}
],
"uuid": "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
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
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 updating a rule.
Updated rule data
Show child attributes
Show child attributes
Last modified on May 23, 2026
Was this page helpful?
⌘I