Skip to main content
POST
Update audio gateway details

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 to update details for an audio gateway. Note: uuid is a required field.

associatedCameras
(string<DeviceFacetUuid> | null)[] | null

List of associated camera device UUIDs

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

associatedCamerasUpdated
boolean | null
deleted
boolean | null

Indicates whether the audio gateway is deleted

Example:

false

deletedUpdated
boolean | null
description
string | null

Description of the audio gateway

Example:

"Audio gateway for main entrance monitoring"

descriptionUpdated
boolean | null
floorNumber
integer<int32> | null
int32

Floor number where the audio gateway is located

Example:

1

floorNumberUpdated
boolean | null
latitude
number<double> | null
double

Latitude coordinate of the audio gateway location

Example:

37.7749

latitudeUpdated
boolean | null
locationUuid
string<RUUID> | null
RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

locationUuidUpdated
boolean | null
longitude
number<double> | null
double

Longitude coordinate of the audio gateway location

Example:

-122.4194

longitudeUpdated
boolean | null
name
string | null

Name of the audio gateway

Example:

"Main Entrance Audio Gateway"

nameUpdated
boolean | null
policyUuid
string<RUUID> | null
RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

policyUuidUpdated
boolean | null
subLocationsHierarchyKey
string<SubLocationsHierarchyKey> | null
SubLocationsHierarchyKey

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$
Example:

"AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

subLocationsHierarchyKeyUpdated
boolean | null
uuid
string<RUUID> | null
RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response indicating the result of updating audio gateway details.

error
boolean | null
errorMsg
string | null
warningMsg
string | null
Last modified on August 3, 2026