Update Envoy integration

Update Envoy badge integration

POST /api/integrations/serviceManagement/updateEnvoyIntegration

Update Envoy integration

cURL

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
  }
}
'

200

{
  "authError": false,
  "error": true,
  "errorMsg": "<string>",
  "failedGuids": [
    "<string>"
  ],
  "misconfiguredDoors": [
    "<string>"
  ],
  "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 updating Envoy visitor management integration settings.

envoySettings · object

Envoy visitor management integration settings to update

Show child attributes

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