Skip to main content
POST
/
api
/
accesscontrol
/
lockdownPlan
/
updateLocationLockdownPlan
Update location lockdown plan
curl --request POST \
  --url https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/updateLocationLockdownPlan \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "activationPlan": {
    "groupUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "rhombusKeyNotificationMessage": "<string>",
    "userUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ]
  },
  "deactivationPlan": {
    "groupUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "rhombusKeyNotificationMessage": "<string>",
    "userUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ]
  },
  "defaultLockdownState": "LOCKED_DOWN",
  "doorLockdownStateMap": {},
  "lockdownPlanUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "name": "<string>",
  "physicalAccess": {
    "groupUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "userUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ]
  },
  "testPlan": {
    "doorStateOverrideEnabled": true,
    "userAccessOverrideEnabled": true
  }
}
'
{
  "lockdownPlan": {
    "activationPlan": {
      "groupUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "rhombusKeyNotificationMessage": "<string>",
      "userUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ]
    },
    "createdAtMillis": 123,
    "deactivationPlan": {
      "groupUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "rhombusKeyNotificationMessage": "<string>",
      "userUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ]
    },
    "defaultLockdownState": "LOCKED_DOWN",
    "doorLockdownStateMap": {},
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "name": "<string>",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "physicalAccess": {
      "groupUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "userUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ]
    },
    "scopeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "testPlan": {
      "doorStateOverrideEnabled": true,
      "userAccessOverrideEnabled": true
    },
    "type": "ORG_LOCKDOWN",
    "updatedAtMillis": 123,
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

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 update an existing location lockdown plan with selective field updates.

​
activationPlan
object
​
deactivationPlan
object
​
defaultLockdownState
enum<string>
Available options:
LOCKED_DOWN,
ACCESS_CONTROLLED,
UNLOCKED,
UNKNOWN
​
doorLockdownStateMap
object
​
lockdownPlanUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

​
name
string | null
​
physicalAccess
object
​
testPlan
object

Response

200 - application/json

OK

Response containing the updated location lockdown plan.

​
lockdownPlan
object

The updated location lockdown plan.