Update room device setting

patch

https://{nurevaDeviceIP}/api/v1/room/devices/{deviceId}

Allows clients to update the configuration for a specific room device identified by deviceId. Supported properties depend on the configured device type and current capabilities.

Minimum role required: general

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

deviceId

string

required

Unique identifier for the configured room device.

Headers

Nureva-Client-Id

string

required

Identifier for the integration application or service. This is intended for you to specify the name of your integration. Use this same value every time your integration calls into the Nureva device. There is no strict format as long as the value is limited to 500 characters. For example, "MyCompany Integration", "Power API", "SyncMaster", "Cloud Orchestrator", "Ultimate Audio Overlord" are all acceptable values.

Nureva-Client-Version

string

required

Identifier for the integration version. This is intended for you to specify the version of your integration application or service. There is no strict format as long as the value is limited to 500 characters. For example, "1", "2.0", "1.5.2", "beta", "1.0.0-alpha", "1.0.0+20250102" are all acceptable values.

Body Params

The request body to update a room device configuration.

Request body for updating a room device. Supported properties depend on the existing device type identified by the deviceId path parameter. Include at least one supported property to update.

modelName

string

Updated model name for the IP device.

otherDeviceType

string

Updated custom device type label for an IP device whose ipDeviceType is Other.

customName

string

Updated user-defined display name for the room device.

ipAddress

string

Updated IPv4 address for an IP device.

port

integer

Updated port number for an IP device or camera switcher.

ipOrHostname

string

Updated IP address or hostname for the camera switcher.

username

string

Updated username used to generate a camera switcher access token.

password

string

Updated password used to generate a camera switcher access token.

accessToken

string

Updated camera switcher access token.

enabled

boolean

Updated enabled state for the camera switcher integration.

signalLevelGain

integer

Updated HDX signal gain level for an auxiliary input, auxiliary output, or external microphone.

isMuted

boolean

Updated HDX mute state for an auxiliary input, auxiliary output, or external microphone.

voiceAmplificationEnabled

boolean

Updated Adaptive Voice Amplification enabled state.

voiceAmplificationLevel

integer

Updated Adaptive Voice Amplification level.

voiceAmplificationAuxInLevel

string

enum

Updated auxiliary input level used by Adaptive Voice Amplification.

Allowed:

microphoneDuckingEnabled

boolean

Updated microphone ducking enabled state.

voiceAmplificationGateThreshold

number

Updated gate threshold for the external microphone.

voiceAmplificationUsbOutputGainLevel

number

Updated USB output gain level for external microphone audio.

auxiliaryOutputState

string

enum

Updated auxiliary output mode.

Allowed:

noiseSuppressionEnabled

boolean

Updated HDX noise suppression enabled state for an auxiliary output.

outputMix

object

Updated HDX mix configuration for an auxiliary output.

Responses

200Success

400Bad Request. Either one of the required headers are missing

401Unauthorized. Invalid or missing credentials

403Forbidden. The authenticated user does not have sufficient permissions for this endpoint

404Device not found. Invalid or missing deviceId

429Too many requests. Rate limit is exceeded

500Internal Server Error. Unexpected error has occurred.