Create location lockdown plan
curl --request POST \
--url https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/createLocationLockdownPlan \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"lockdownPlan": {
"activationPlan": {
"groupUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"rhombusKeyNotificationMessage": "<string>",
"userUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"createdAtMillis": 123,
"deactivationPlan": {
"groupUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"rhombusKeyNotificationMessage": "<string>",
"userUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"doorLockdownStateMap": {},
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"physicalAccess": {
"groupUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"userUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"scopeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"testPlan": {
"doorStateOverrideEnabled": true,
"userAccessOverrideEnabled": true
},
"updatedAtMillis": 123,
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
}
'import requests
url = "https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/createLocationLockdownPlan"
payload = { "lockdownPlan": {
"activationPlan": {
"groupUuids": ["AAAAAAAAAAAAAAAAAAAAAA"],
"rhombusKeyNotificationMessage": "<string>",
"userUuids": ["AAAAAAAAAAAAAAAAAAAAAA"]
},
"createdAtMillis": 123,
"deactivationPlan": {
"groupUuids": ["AAAAAAAAAAAAAAAAAAAAAA"],
"rhombusKeyNotificationMessage": "<string>",
"userUuids": ["AAAAAAAAAAAAAAAAAAAAAA"]
},
"doorLockdownStateMap": {},
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"physicalAccess": {
"groupUuids": ["AAAAAAAAAAAAAAAAAAAAAA"],
"userUuids": ["AAAAAAAAAAAAAAAAAAAAAA"]
},
"scopeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"testPlan": {
"doorStateOverrideEnabled": True,
"userAccessOverrideEnabled": True
},
"updatedAtMillis": 123,
"uuid": "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({
lockdownPlan: {
activationPlan: {
groupUuids: ['AAAAAAAAAAAAAAAAAAAAAA'],
rhombusKeyNotificationMessage: '<string>',
userUuids: ['AAAAAAAAAAAAAAAAAAAAAA']
},
createdAtMillis: 123,
deactivationPlan: {
groupUuids: ['AAAAAAAAAAAAAAAAAAAAAA'],
rhombusKeyNotificationMessage: '<string>',
userUuids: ['AAAAAAAAAAAAAAAAAAAAAA']
},
doorLockdownStateMap: {},
locationUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
name: '<string>',
orgUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
physicalAccess: {groupUuids: ['AAAAAAAAAAAAAAAAAAAAAA'], userUuids: ['AAAAAAAAAAAAAAAAAAAAAA']},
scopeUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
testPlan: {doorStateOverrideEnabled: true, userAccessOverrideEnabled: true},
updatedAtMillis: 123,
uuid: 'AAAAAAAAAAAAAAAAAAAAAA'
}
})
};
fetch('https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/createLocationLockdownPlan', 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/accesscontrol/lockdownPlan/createLocationLockdownPlan")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"lockdownPlan\": {\n \"activationPlan\": {\n \"groupUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ],\n \"rhombusKeyNotificationMessage\": \"<string>\",\n \"userUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ]\n },\n \"createdAtMillis\": 123,\n \"deactivationPlan\": {\n \"groupUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ],\n \"rhombusKeyNotificationMessage\": \"<string>\",\n \"userUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ]\n },\n \"doorLockdownStateMap\": {},\n \"locationUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"name\": \"<string>\",\n \"orgUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"physicalAccess\": {\n \"groupUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ],\n \"userUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ]\n },\n \"scopeUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"testPlan\": {\n \"doorStateOverrideEnabled\": true,\n \"userAccessOverrideEnabled\": true\n },\n \"updatedAtMillis\": 123,\n \"uuid\": \"AAAAAAAAAAAAAAAAAAAAAA\"\n }\n}")
.asString();{
"lockdownPlan": {
"activationPlan": {
"groupUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"rhombusKeyNotificationMessage": "<string>",
"userUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"createdAtMillis": 123,
"deactivationPlan": {
"groupUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"rhombusKeyNotificationMessage": "<string>",
"userUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"doorLockdownStateMap": {},
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"physicalAccess": {
"groupUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"userUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"scopeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"testPlan": {
"doorStateOverrideEnabled": true,
"userAccessOverrideEnabled": true
},
"updatedAtMillis": 123,
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
}Lockdown Plan Webservice
Create location lockdown plan
Create location lockdown plan
POST
/
api
/
accesscontrol
/
lockdownPlan
/
createLocationLockdownPlan
Create location lockdown plan
curl --request POST \
--url https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/createLocationLockdownPlan \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"lockdownPlan": {
"activationPlan": {
"groupUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"rhombusKeyNotificationMessage": "<string>",
"userUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"createdAtMillis": 123,
"deactivationPlan": {
"groupUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"rhombusKeyNotificationMessage": "<string>",
"userUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"doorLockdownStateMap": {},
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"physicalAccess": {
"groupUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"userUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"scopeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"testPlan": {
"doorStateOverrideEnabled": true,
"userAccessOverrideEnabled": true
},
"updatedAtMillis": 123,
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
}
'import requests
url = "https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/createLocationLockdownPlan"
payload = { "lockdownPlan": {
"activationPlan": {
"groupUuids": ["AAAAAAAAAAAAAAAAAAAAAA"],
"rhombusKeyNotificationMessage": "<string>",
"userUuids": ["AAAAAAAAAAAAAAAAAAAAAA"]
},
"createdAtMillis": 123,
"deactivationPlan": {
"groupUuids": ["AAAAAAAAAAAAAAAAAAAAAA"],
"rhombusKeyNotificationMessage": "<string>",
"userUuids": ["AAAAAAAAAAAAAAAAAAAAAA"]
},
"doorLockdownStateMap": {},
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"physicalAccess": {
"groupUuids": ["AAAAAAAAAAAAAAAAAAAAAA"],
"userUuids": ["AAAAAAAAAAAAAAAAAAAAAA"]
},
"scopeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"testPlan": {
"doorStateOverrideEnabled": True,
"userAccessOverrideEnabled": True
},
"updatedAtMillis": 123,
"uuid": "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({
lockdownPlan: {
activationPlan: {
groupUuids: ['AAAAAAAAAAAAAAAAAAAAAA'],
rhombusKeyNotificationMessage: '<string>',
userUuids: ['AAAAAAAAAAAAAAAAAAAAAA']
},
createdAtMillis: 123,
deactivationPlan: {
groupUuids: ['AAAAAAAAAAAAAAAAAAAAAA'],
rhombusKeyNotificationMessage: '<string>',
userUuids: ['AAAAAAAAAAAAAAAAAAAAAA']
},
doorLockdownStateMap: {},
locationUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
name: '<string>',
orgUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
physicalAccess: {groupUuids: ['AAAAAAAAAAAAAAAAAAAAAA'], userUuids: ['AAAAAAAAAAAAAAAAAAAAAA']},
scopeUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
testPlan: {doorStateOverrideEnabled: true, userAccessOverrideEnabled: true},
updatedAtMillis: 123,
uuid: 'AAAAAAAAAAAAAAAAAAAAAA'
}
})
};
fetch('https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/createLocationLockdownPlan', 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/accesscontrol/lockdownPlan/createLocationLockdownPlan")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"lockdownPlan\": {\n \"activationPlan\": {\n \"groupUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ],\n \"rhombusKeyNotificationMessage\": \"<string>\",\n \"userUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ]\n },\n \"createdAtMillis\": 123,\n \"deactivationPlan\": {\n \"groupUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ],\n \"rhombusKeyNotificationMessage\": \"<string>\",\n \"userUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ]\n },\n \"doorLockdownStateMap\": {},\n \"locationUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"name\": \"<string>\",\n \"orgUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"physicalAccess\": {\n \"groupUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ],\n \"userUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ]\n },\n \"scopeUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"testPlan\": {\n \"doorStateOverrideEnabled\": true,\n \"userAccessOverrideEnabled\": true\n },\n \"updatedAtMillis\": 123,\n \"uuid\": \"AAAAAAAAAAAAAAAAAAAAAA\"\n }\n}")
.asString();{
"lockdownPlan": {
"activationPlan": {
"groupUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"rhombusKeyNotificationMessage": "<string>",
"userUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"createdAtMillis": 123,
"deactivationPlan": {
"groupUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"rhombusKeyNotificationMessage": "<string>",
"userUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"doorLockdownStateMap": {},
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"physicalAccess": {
"groupUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"userUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"scopeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"testPlan": {
"doorStateOverrideEnabled": true,
"userAccessOverrideEnabled": true
},
"updatedAtMillis": 123,
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
}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 to create a new location lockdown plan.
The updated location lockdown plan.
Show child attributes
Show child attributes
Response
200 - application/json
OK
Response containing the created location lockdown plan.
The updated location lockdown plan.
Show child attributes
Show child attributes
Last modified on August 3, 2026
⌘I