Skip to main content
POST
/
api
/
org
/
createOrUpdateHealthNotificationRule
Create or update health notification rule
curl --request POST \
  --url https://api2.rhombussystems.com/api/org/createOrUpdateHealthNotificationRule \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "rule": {
    "deviceCountThreshold": 123,
    "durationMinutes": 123,
    "enabled": true,
    "name": "<string>",
    "notifyOnRecovery": true,
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "reAlertAfterMinutes": [
      123
    ],
    "ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "targetUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ]
  }
}
'
import requests

url = "https://api2.rhombussystems.com/api/org/createOrUpdateHealthNotificationRule"

payload = { "rule": {
"deviceCountThreshold": 123,
"durationMinutes": 123,
"enabled": True,
"name": "<string>",
"notifyOnRecovery": True,
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"reAlertAfterMinutes": [123],
"ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"targetUuids": ["AAAAAAAAAAAAAAAAAAAAAA"]
} }
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
rule: {
deviceCountThreshold: 123,
durationMinutes: 123,
enabled: true,
name: '<string>',
notifyOnRecovery: true,
orgUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
reAlertAfterMinutes: [123],
ruleUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
targetUuids: ['AAAAAAAAAAAAAAAAAAAAAA']
}
})
};

fetch('https://api2.rhombussystems.com/api/org/createOrUpdateHealthNotificationRule', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/org/createOrUpdateHealthNotificationRule")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"rule\": {\n \"deviceCountThreshold\": 123,\n \"durationMinutes\": 123,\n \"enabled\": true,\n \"name\": \"<string>\",\n \"notifyOnRecovery\": true,\n \"orgUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"reAlertAfterMinutes\": [\n 123\n ],\n \"ruleUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"targetUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ]\n }\n}")
.asString();
{
  "error": true,
  "errorMsg": "<string>",
  "rule": {
    "deviceCountThreshold": 123,
    "durationMinutes": 123,
    "enabled": true,
    "name": "<string>",
    "notifyOnRecovery": true,
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "reAlertAfterMinutes": [
      123
    ],
    "ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "targetUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ]
  },
  "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 object for creating or updating a health notification rule.

rule
object

List of health notification rules

Response

200 - application/json

OK

Response object for creating or updating a health notification rule.

error
boolean | null
errorMsg
string | null
rule
object

List of health notification rules

warningMsg
string | null
Last modified on July 11, 2026