Skip to main content
POST
/
api
/
integrations
/
updateDeviceIntegration
Update Device Integration
curl --request POST \
  --url https://api2.rhombussystems.com/api/integrations/updateDeviceIntegration \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "createNewDevice": true,
  "deviceIntegrationSettings": {
    "deviceSettingsMap": {},
    "enabled": true,
    "integration": "AVIGILON_ALTA",
    "integrationAuditMap": {},
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
  },
  "latitude": 37.7749,
  "longitude": -122.4194,
  "name": "Main Entrance Camera",
  "updateDevice": false,
  "updateDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'
{
  "authError": false,
  "error": true,
  "errorMsg": "<string>",
  "failedGuids": [
    "<string>"
  ],
  "misconfiguredDoors": [
    "<string>"
  ],
  "warningMsg": "<string>"
}

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 object for updating device integration settings and device properties.

createNewDevice
boolean | null

Whether to create a new device

Example:

true

deviceIntegrationSettings
object

Device integration settings to update

latitude
number<double> | null

Latitude coordinate of the device location

Example:

37.7749

longitude
number<double> | null

Longitude coordinate of the device location

Example:

-122.4194

name
string | null

Name of the device

Example:

"Main Entrance Camera"

updateDevice
boolean | null

Whether to update an existing device

Example:

false

updateDeviceUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object for updating organization integrations.

authError
boolean | null

Whether an authentication error occurred during update

Example:

false

error
boolean | null
errorMsg
string | null
failedGuids
(string | null)[] | null

List of GUIDs that failed to update

List of GUIDs that failed to update

misconfiguredDoors
(string | null)[] | null

List of door names that are assigned to multiple Rhombus locations

List of door names that are assigned to multiple Rhombus locations

warningMsg
string | null