Skip to main content
POST
/
api
/
integrations
/
serviceManagement
/
updateEnvoyIntegration
Update Envoy integration
curl --request POST \
  --url https://api2.rhombussystems.com/api/integrations/serviceManagement/updateEnvoyIntegration \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "envoySettings": {
    "createSeekPoints": true,
    "enabled": true,
    "enabledTimestampMs": 123,
    "enablingUser": "<string>",
    "enablingUserUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "envoyIntegrationInstalled": true,
    "indexFaces": true,
    "locationInfoMap": {},
    "migrated": true,
    "refreshToken": "<string>",
    "saveClips": true
  }
}
'
{
  "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 Envoy visitor management integration settings.

​
envoySettings
object

Envoy visitor management integration settings to update

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