Partner

Customize client device

Customize a client device

POST/api/partner/customizeClientDevice

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the write scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: partner-api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

Request object for customizing client device settings and configurations.

clientDeviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

clientOrgUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

configUpdateobjectbody

Audio/video user configuration update

Show child attributes

ai_license_invalidboolean | nullbody

audio_aec_via_softwareboolean | nullbody

audio_ai_disabledboolean | nullbody

audio_external_mic_boostinteger<int32> | nullbody

audio_external_mic_volumeinteger<int32> | nullbody

audio_external_speaker_volumeinteger<int32> | nullbody

audio_internal_mic_aec_enabledboolean | nullbody

audio_internal_mic_boostinteger<int32> | nullbody

audio_internal_mic_volumeinteger<int32> | nullbody

audio_internal_speaker_volumeinteger<int32> | nullbody

audio_min_echo_amplitudeinteger<int32> | nullbody

audio_playback_gain_percentinteger<int32> | nullbody

audio_recordboolean | nullbody

audio_supportedboolean | nullbody

audio_use_external_micboolean | nullbody

audio_use_external_speakerboolean | nullbody

audio_use_internal_speakerboolean | nullbody

bandwidth_reports_disabledboolean | nullbody

blocked_debounce_time_msinteger<int32> | nullbody

blocked_thresholdnumber<float> | nullbody

char_thresholdnumber<float> | nullbody

cloud_ai_smart_crop_enabledboolean | nullbody

cloud_ai_stream_enabledboolean | nullbody

core_event_upload_targetenum<string>body

Available options: 0, 1, 2

crossing_regionsobject[] | nullbody

Show child attributes

directionsenum<string>[] | nullbody

enabledboolean | nullbody

in_roiobjectbody

Show child attributes

coordinatesobject[] | nullbody

Show child attributes

xnumber<float> | nullbody

ynumber<float> | nullbody

namestring | nullbody

object_typeenum<string>body

Available options: HUMAN, VEHICLE, FACE, LPR, POSE, CLIP_EMBED, UNKNOWN

out_roiobjectbody

Show child attributes

coordinatesobject[] | nullbody

Show child attributes

xnumber<float> | nullbody

ynumber<float> | nullbody

uuidstring | nullbody

custom_eventsboolean | nullbody

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

device_mic_enabledboolean | nullbody

device_near_audio_silencedboolean | nullbody

device_speaker_enabledboolean | nullbody

dewarpModeenum<string>body

Available options: NO_TRANSFORM, NORMAL, PANORAMA, SUB_REGION, VERTICAL_PANORAMA, TRANSVERSE_MERCATOR, MERCATOR, EQUIRECTANGULAR

disabled_scheduleobject[] | nullbody

Show child attributes

minuteOfWeekStartinteger<int32> | nullbody

minuteOfWeekStopinteger<int32> | nullbody

disabled_schedule_invertedboolean | nullbody

disabled_schedule_uuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

dwell_reset_ttl_msinteger<int64> | nullbody

dwell_time_msinteger<int64> | nullbody

exposure_levelinteger<int32> | nullbody

firmware_dev_settingsobject | nullbody

fisheye_display_modeenum<string>body

Available options: RAW, IMMERSIVE, TILES, RAW_PANO

floorplan_homographynumber<double>[][] | nullbody

frontendEqualizerHighShelfobjectbody

Show child attributes

frequencyinteger<int32> | nullbody

gaininteger<int32> | nullbody

qinteger<int32> | nullbody

frontendEqualizerLowShelfobjectbody

Show child attributes

frequencyinteger<int32> | nullbody

gaininteger<int32> | nullbody

qinteger<int32> | nullbody

frontendEqualizerPeaking1objectbody

Show child attributes

frequencyinteger<int32> | nullbody

gaininteger<int32> | nullbody

qinteger<int32> | nullbody

frontendEqualizerPeaking2objectbody

Show child attributes

frequencyinteger<int32> | nullbody

gaininteger<int32> | nullbody

qinteger<int32> | nullbody

frontendEqualizerPeaking3objectbody

Show child attributes

frequencyinteger<int32> | nullbody

gaininteger<int32> | nullbody

qinteger<int32> | nullbody

frontendNoiseSuppressionboolean | nullbody

h265_realtime_encoding_enabledboolean | nullbody

h265_vod_encoding_enabledboolean | nullbody

hdr_enabledboolean | nullbody

high_res_detectionboolean | nullbody

human_detectionboolean | nullbody

human_loiteringboolean | nullbody

human_loitering_settingsobjectbody

Show child attributes

roiobject[] | nullbody

Show child attributes

coordinatesobject[] | nullbody

Show child attributes

xnumber<float> | nullbody

ynumber<float> | nullbody

img_brightnessinteger<int32> | nullbody

img_contrastinteger<int32> | nullbody

img_saturationinteger<int32> | nullbody

img_sharpnessinteger<int32> | nullbody

inactivity_settingsobjectbody

Show child attributes

object_typeenum<string>body

Available options: HUMAN, VEHICLE

roiobjectbody

Show child attributes

coordinatesobject[] | nullbody

Show child attributes

xnumber<float> | nullbody

ynumber<float> | nullbody

threshold_msinteger<int64> | nullbody

lastModifiedinteger<int64> | nullbody

led_mode_blink_period_msinteger<int64> | nullbody

led_mode_when_activeenum<string>body

Available options: LED_OFF, LED_RED_SOLID, LED_GREEN_SOLID, LED_ORANGE_SOLID, LED_RED_BLINK, LED_GREEN_BLINK, LED_ORANGE_BLINK, LED_NORMAL

led_mode_when_inactiveenum<string>body

Available options: LED_OFF, LED_RED_SOLID, LED_GREEN_SOLID, LED_ORANGE_SOLID, LED_RED_BLINK, LED_GREEN_BLINK, LED_ORANGE_BLINK, LED_NORMAL

led_stealth_modeboolean | nullbody

lightweight_detection_disabledboolean | nullbody

live_license_invalidboolean | nullbody

max_detections_per_frameinteger<int32> | nullbody

media_ttl_minutesinteger<int32> | nullbody

metering_configobjectbody

Show child attributes

rotationinteger<int32> | nullbody

tablestring | nullbody

motor_configobjectbody

Show child attributes

af_enabledboolean | nullbody

af_regionobjectbody

Show child attributes

hinteger<int32> | nullbody

sizeinteger<int32> | nullbody

winteger<int32> | nullbody

xinteger<int32> | nullbody

yinteger<int32> | nullbody

focusinteger<int32> | nullbody

pan_degreesnumber<float> | nullbody

pirisinteger<int32> | nullbody

pt_speedinteger<int32> | nullbody

tilt_degreesnumber<float> | nullbody

zoominteger<int32> | nullbody

mounting_directionenum<string>body

Available options: DOWN, UP, SIDEWAYS, UNKNOWN

night_exposure_levelinteger<int32> | nullbody

night_img_brightnessinteger<int32> | nullbody

night_img_contrastinteger<int32> | nullbody

night_img_saturationinteger<int32> | nullbody

night_img_sharpnessinteger<int32> | nullbody

night_metering_configobjectbody

Show child attributes

rotationinteger<int32> | nullbody

tablestring | nullbody

night_sensor_gain_maxinteger<int32> | nullbody

night_shutter_time_maxinteger<int32> | nullbody

night_shutter_time_mininteger<int32> | nullbody

object_searchboolean | nullbody

occupancy_count_high_thresholdinteger<int32> | nullbody

occupancy_count_low_thresholdinteger<int32> | nullbody

occupancy_countingboolean | nullbody

on_demand_license_invalidboolean | nullbody

orgUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

people_trackingboolean | nullbody

person_reidentificationboolean | nullbody

privacy_window_polygonsobject[] | nullbody

Show child attributes

coordinatesobject[] | nullbody

Show child attributes

xnumber<float> | nullbody

ynumber<float> | nullbody

privacy_windowsobject[] | nullbody

Show child attributes

hinteger<int32> | nullbody

sizeinteger<int32> | nullbody

winteger<int32> | nullbody

xinteger<int32> | nullbody

yinteger<int32> | nullbody

ptz_configobjectbody

Show child attributes

offset_x_percentnumber<float> | nullbody

offset_y_percentnumber<float> | nullbody

rotationinteger<int32> | nullbody

size_percentnumber<float> | nullbody

ptz_homeobjectbody

Show child attributes

go_home_seqinteger<int64> | nullbody

pan_degreesnumber<float> | nullbody

tilt_degreesnumber<float> | nullbody

zoominteger<int32> | nullbody

record_on_motionboolean | nullbody

region_for_occupancyobject | nullbody

Show child attributes

invertedboolean | nullbody

polygonsobject[] | nullbody

Show child attributes

coordinatesobject[] | nullbody

Show child attributes

xnumber<float> | nullbody

ynumber<float> | nullbody

region_of_interestobject | nullbody

Show child attributes

invertedboolean | nullbody

polygonsobject[] | nullbody

Show child attributes

coordinatesobject[] | nullbody

Show child attributes

xnumber<float> | nullbody

ynumber<float> | nullbody

region_of_interest_groupsobject[] | nullbody

Show child attributes

inclusiveboolean | nullbody

If true, regions in this group include specified activities. If false, regions in this group exclude specified activities.

regionsOfInterestobject[] | nullbody

Regions of interest that belong to the group. Group must have at least one region specified.

Show child attributes

activitiesenum<string>[] | nullbody

Region of allowed or disallowed activities. Activities are allowed if region group is inclusive. Activities are disallowed if region group is exclusive. Region must have at least one activity specified.

namestring | nullbody

polygonobjectbody

Show child attributes

coordinatesobject[] | nullbody

Show child attributes

xnumber<float> | nullbody

ynumber<float> | nullbody

uuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

scheduleUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>body

Represents type of activity regions in the group. Defaults to 'Activity'.

Available options: ACTIVITY, REPORTING, CROSSING, ALARM_MONITORING, UNKNOWN

resolutionobjectbody

Show child attributes

heightinteger<int32> | nullbody

widthinteger<int32> | nullbody

rotationinteger<int32> | nullbody

rtsp_encoderinteger<int32> | nullbody

segment_max_bytesinteger<int32> | nullbody

sensor_gain_maxinteger<int32> | nullbody

shared_fovstring<DeviceFacetUuid>[] | nullbody

shutter_time_maxinteger<int32> | nullbody

shutter_time_mininteger<int32> | nullbody

snapshot_heightinteger<int32> | nullbody

snapshot_interval_secsinteger<int32> | nullbody

snapshot_upload_targetenum<string>body

Available options: 0, 1, 2

storage_target_free_megabytesinteger<int32> | nullbody

storage_target_free_space_permyriadinteger<int32> | nullbody

thumbstrip_upload_targetenum<string>body

Available options: 0, 1, 2

tile_viewsobject[] | nullbody

Show child attributes

aspectRatioobjectbody

Show child attributes

heightinteger<int32> | nullbody

widthinteger<int32> | nullbody

pitchDegreesnumber<float> | nullbody

rollDegreesnumber<float> | nullbody

verticalFieldOfViewDegreesinteger<int32> | nullbody

yawDegreesnumber<float> | nullbody

upload_all_detectionsboolean | nullbody

use_onboard_lprboolean | nullbody

vehicle_detectionboolean | nullbody

video_ai_disabledboolean | nullbody

video_persist_disabledboolean | nullbody

wdr_enabledboolean | nullbody

wdr_strengthinteger<int32> | nullbody

zero_motion_video_bitrate_percentinteger<int32> | nullbody

customizationsobjectbody

Client device-specific customization settings for partner management.

Show child attributes

forceLowBandwidthOnAllCamerasboolean | nullbody

Whether to force low bandwidth on all cameras

Example: false

inactivityTimeoutinteger<int32> | nullbody

Inactivity timeout in minutes

Example: 30

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/partner/customizeClientDevice' \
  --header 'x-auth-scheme: partner-api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "clientDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "configUpdate": {
      "ai_license_invalid": true,
      "audio_aec_via_software": true,
      "audio_ai_disabled": true,
      "audio_external_mic_boost": 0,
      "audio_external_mic_volume": 0,
      "audio_external_speaker_volume": 0,
      "audio_internal_mic_aec_enabled": true,
      "audio_internal_mic_boost": 0,
      "audio_internal_mic_volume": 0,
      "audio_internal_speaker_volume": 0,
      "audio_min_echo_amplitude": 0,
      "audio_playback_gain_percent": 0,
      "audio_record": true,
      "audio_supported": true,
      "audio_use_external_mic": true,
      "audio_use_external_speaker": true,
      "audio_use_internal_speaker": true,
      "bandwidth_reports_disabled": true,
      "blocked_debounce_time_ms": 0,
      "blocked_threshold": 0,
      "char_threshold": 0,
      "cloud_ai_smart_crop_enabled": true,
      "cloud_ai_stream_enabled": true,
      "core_event_upload_target": "0",
      "crossing_regions": [],
      "custom_events": true,
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "device_mic_enabled": true,
      "device_near_audio_silenced": true,
      "device_speaker_enabled": true,
      "dewarpMode": "NORMAL",
      "disabled_schedule": [],
      "disabled_schedule_inverted": true,
      "disabled_schedule_uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "dwell_reset_ttl_ms": 0,
      "dwell_time_ms": 0,
      "exposure_level": 0,
      "firmware_dev_settings": {},
      "fisheye_display_mode": "RAW",
      "floorplan_homography": [],
      "frontendEqualizerHighShelf": {},
      "frontendEqualizerLowShelf": {},
      "frontendEqualizerPeaking1": {},
      "frontendEqualizerPeaking2": {},
      "frontendEqualizerPeaking3": {},
      "frontendNoiseSuppression": true,
      "h265_realtime_encoding_enabled": true,
      "h265_vod_encoding_enabled": true,
      "hdr_enabled": true,
      "high_res_detection": true,
      "human_detection": true,
      "human_loitering": true,
      "human_loitering_settings": {},
      "img_brightness": 0,
      "img_contrast": 0,
      "img_saturation": 0,
      "img_sharpness": 0,
      "inactivity_settings": {},
      "lastModified": 0,
      "led_mode_blink_period_ms": 0,
      "led_mode_when_active": "LED_OFF",
      "led_mode_when_inactive": "LED_OFF",
      "led_stealth_mode": true,
      "lightweight_detection_disabled": true,
      "live_license_invalid": true,
      "max_detections_per_frame": 0,
      "media_ttl_minutes": 0,
      "metering_config": {},
      "motor_config": {},
      "mounting_direction": "DOWN",
      "night_exposure_level": 0,
      "night_img_brightness": 0,
      "night_img_contrast": 0,
      "night_img_saturation": 0,
      "night_img_sharpness": 0,
      "night_metering_config": {},
      "night_sensor_gain_max": 0,
      "night_shutter_time_max": 0,
      "night_shutter_time_min": 0,
      "object_search": true,
      "occupancy_count_high_threshold": 0,
      "occupancy_count_low_threshold": 0,
      "occupancy_counting": true,
      "on_demand_license_invalid": true,
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "people_tracking": true,
      "person_reidentification": true,
      "privacy_window_polygons": [],
      "privacy_windows": [],
      "ptz_config": {},
      "ptz_home": {},
      "record_on_motion": true,
      "region_for_occupancy": {},
      "region_of_interest": {},
      "region_of_interest_groups": [],
      "resolution": {},
      "rotation": 0,
      "rtsp_encoder": 0,
      "segment_max_bytes": 0,
      "sensor_gain_max": 0,
      "shared_fov": [],
      "shutter_time_max": 0,
      "shutter_time_min": 0,
      "snapshot_height": 0,
      "snapshot_interval_secs": 0,
      "snapshot_upload_target": "0",
      "storage_target_free_megabytes": 0,
      "storage_target_free_space_permyriad": 0,
      "thumbstrip_upload_target": "0",
      "tile_views": [],
      "upload_all_detections": true,
      "use_onboard_lpr": true,
      "vehicle_detection": true,
      "video_ai_disabled": true,
      "video_persist_disabled": true,
      "wdr_enabled": true,
      "wdr_strength": 0,
      "zero_motion_video_bitrate_percent": 0
    },
    "customizations": {
      "forceLowBandwidthOnAllCameras": false,
      "inactivityTimeout": 30
    }
  }'

import requests

url = "https://api2.rhombussystems.com/api/partner/customizeClientDevice"
headers = {
    "x-auth-scheme": "partner-api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "clientDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "configUpdate": {
        "ai_license_invalid": True,
        "audio_aec_via_software": True,
        "audio_ai_disabled": True,
        "audio_external_mic_boost": 0,
        "audio_external_mic_volume": 0,
        "audio_external_speaker_volume": 0,
        "audio_internal_mic_aec_enabled": True,
        "audio_internal_mic_boost": 0,
        "audio_internal_mic_volume": 0,
        "audio_internal_speaker_volume": 0,
        "audio_min_echo_amplitude": 0,
        "audio_playback_gain_percent": 0,
        "audio_record": True,
        "audio_supported": True,
        "audio_use_external_mic": True,
        "audio_use_external_speaker": True,
        "audio_use_internal_speaker": True,
        "bandwidth_reports_disabled": True,
        "blocked_debounce_time_ms": 0,
        "blocked_threshold": 0,
        "char_threshold": 0,
        "cloud_ai_smart_crop_enabled": True,
        "cloud_ai_stream_enabled": True,
        "core_event_upload_target": "0",
        "crossing_regions": [],
        "custom_events": True,
        "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "device_mic_enabled": True,
        "device_near_audio_silenced": True,
        "device_speaker_enabled": True,
        "dewarpMode": "NORMAL",
        "disabled_schedule": [],
        "disabled_schedule_inverted": True,
        "disabled_schedule_uuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "dwell_reset_ttl_ms": 0,
        "dwell_time_ms": 0,
        "exposure_level": 0,
        "firmware_dev_settings": {},
        "fisheye_display_mode": "RAW",
        "floorplan_homography": [],
        "frontendEqualizerHighShelf": {},
        "frontendEqualizerLowShelf": {},
        "frontendEqualizerPeaking1": {},
        "frontendEqualizerPeaking2": {},
        "frontendEqualizerPeaking3": {},
        "frontendNoiseSuppression": True,
        "h265_realtime_encoding_enabled": True,
        "h265_vod_encoding_enabled": True,
        "hdr_enabled": True,
        "high_res_detection": True,
        "human_detection": True,
        "human_loitering": True,
        "human_loitering_settings": {},
        "img_brightness": 0,
        "img_contrast": 0,
        "img_saturation": 0,
        "img_sharpness": 0,
        "inactivity_settings": {},
        "lastModified": 0,
        "led_mode_blink_period_ms": 0,
        "led_mode_when_active": "LED_OFF",
        "led_mode_when_inactive": "LED_OFF",
        "led_stealth_mode": True,
        "lightweight_detection_disabled": True,
        "live_license_invalid": True,
        "max_detections_per_frame": 0,
        "media_ttl_minutes": 0,
        "metering_config": {},
        "motor_config": {},
        "mounting_direction": "DOWN",
        "night_exposure_level": 0,
        "night_img_brightness": 0,
        "night_img_contrast": 0,
        "night_img_saturation": 0,
        "night_img_sharpness": 0,
        "night_metering_config": {},
        "night_sensor_gain_max": 0,
        "night_shutter_time_max": 0,
        "night_shutter_time_min": 0,
        "object_search": True,
        "occupancy_count_high_threshold": 0,
        "occupancy_count_low_threshold": 0,
        "occupancy_counting": True,
        "on_demand_license_invalid": True,
        "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "people_tracking": True,
        "person_reidentification": True,
        "privacy_window_polygons": [],
        "privacy_windows": [],
        "ptz_config": {},
        "ptz_home": {},
        "record_on_motion": True,
        "region_for_occupancy": {},
        "region_of_interest": {},
        "region_of_interest_groups": [],
        "resolution": {},
        "rotation": 0,
        "rtsp_encoder": 0,
        "segment_max_bytes": 0,
        "sensor_gain_max": 0,
        "shared_fov": [],
        "shutter_time_max": 0,
        "shutter_time_min": 0,
        "snapshot_height": 0,
        "snapshot_interval_secs": 0,
        "snapshot_upload_target": "0",
        "storage_target_free_megabytes": 0,
        "storage_target_free_space_permyriad": 0,
        "thumbstrip_upload_target": "0",
        "tile_views": [],
        "upload_all_detections": True,
        "use_onboard_lpr": True,
        "vehicle_detection": True,
        "video_ai_disabled": True,
        "video_persist_disabled": True,
        "wdr_enabled": True,
        "wdr_strength": 0,
        "zero_motion_video_bitrate_percent": 0
    },
    "customizations": {
        "forceLowBandwidthOnAllCameras": False,
        "inactivityTimeout": 30
    }
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/partner/customizeClientDevice', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'partner-api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "clientDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "configUpdate": {
      "ai_license_invalid": true,
      "audio_aec_via_software": true,
      "audio_ai_disabled": true,
      "audio_external_mic_boost": 0,
      "audio_external_mic_volume": 0,
      "audio_external_speaker_volume": 0,
      "audio_internal_mic_aec_enabled": true,
      "audio_internal_mic_boost": 0,
      "audio_internal_mic_volume": 0,
      "audio_internal_speaker_volume": 0,
      "audio_min_echo_amplitude": 0,
      "audio_playback_gain_percent": 0,
      "audio_record": true,
      "audio_supported": true,
      "audio_use_external_mic": true,
      "audio_use_external_speaker": true,
      "audio_use_internal_speaker": true,
      "bandwidth_reports_disabled": true,
      "blocked_debounce_time_ms": 0,
      "blocked_threshold": 0,
      "char_threshold": 0,
      "cloud_ai_smart_crop_enabled": true,
      "cloud_ai_stream_enabled": true,
      "core_event_upload_target": "0",
      "crossing_regions": [],
      "custom_events": true,
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "device_mic_enabled": true,
      "device_near_audio_silenced": true,
      "device_speaker_enabled": true,
      "dewarpMode": "NORMAL",
      "disabled_schedule": [],
      "disabled_schedule_inverted": true,
      "disabled_schedule_uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "dwell_reset_ttl_ms": 0,
      "dwell_time_ms": 0,
      "exposure_level": 0,
      "firmware_dev_settings": {},
      "fisheye_display_mode": "RAW",
      "floorplan_homography": [],
      "frontendEqualizerHighShelf": {},
      "frontendEqualizerLowShelf": {},
      "frontendEqualizerPeaking1": {},
      "frontendEqualizerPeaking2": {},
      "frontendEqualizerPeaking3": {},
      "frontendNoiseSuppression": true,
      "h265_realtime_encoding_enabled": true,
      "h265_vod_encoding_enabled": true,
      "hdr_enabled": true,
      "high_res_detection": true,
      "human_detection": true,
      "human_loitering": true,
      "human_loitering_settings": {},
      "img_brightness": 0,
      "img_contrast": 0,
      "img_saturation": 0,
      "img_sharpness": 0,
      "inactivity_settings": {},
      "lastModified": 0,
      "led_mode_blink_period_ms": 0,
      "led_mode_when_active": "LED_OFF",
      "led_mode_when_inactive": "LED_OFF",
      "led_stealth_mode": true,
      "lightweight_detection_disabled": true,
      "live_license_invalid": true,
      "max_detections_per_frame": 0,
      "media_ttl_minutes": 0,
      "metering_config": {},
      "motor_config": {},
      "mounting_direction": "DOWN",
      "night_exposure_level": 0,
      "night_img_brightness": 0,
      "night_img_contrast": 0,
      "night_img_saturation": 0,
      "night_img_sharpness": 0,
      "night_metering_config": {},
      "night_sensor_gain_max": 0,
      "night_shutter_time_max": 0,
      "night_shutter_time_min": 0,
      "object_search": true,
      "occupancy_count_high_threshold": 0,
      "occupancy_count_low_threshold": 0,
      "occupancy_counting": true,
      "on_demand_license_invalid": true,
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "people_tracking": true,
      "person_reidentification": true,
      "privacy_window_polygons": [],
      "privacy_windows": [],
      "ptz_config": {},
      "ptz_home": {},
      "record_on_motion": true,
      "region_for_occupancy": {},
      "region_of_interest": {},
      "region_of_interest_groups": [],
      "resolution": {},
      "rotation": 0,
      "rtsp_encoder": 0,
      "segment_max_bytes": 0,
      "sensor_gain_max": 0,
      "shared_fov": [],
      "shutter_time_max": 0,
      "shutter_time_min": 0,
      "snapshot_height": 0,
      "snapshot_interval_secs": 0,
      "snapshot_upload_target": "0",
      "storage_target_free_megabytes": 0,
      "storage_target_free_space_permyriad": 0,
      "thumbstrip_upload_target": "0",
      "tile_views": [],
      "upload_all_detections": true,
      "use_onboard_lpr": true,
      "vehicle_detection": true,
      "video_ai_disabled": true,
      "video_persist_disabled": true,
      "wdr_enabled": true,
      "wdr_strength": 0,
      "zero_motion_video_bitrate_percent": 0
    },
    "customizations": {
      "forceLowBandwidthOnAllCameras": false,
      "inactivityTimeout": 30
    }
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "clientDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "configUpdate": {
                "ai_license_invalid": true,
                "audio_aec_via_software": true,
                "audio_ai_disabled": true,
                "audio_external_mic_boost": 0,
                "audio_external_mic_volume": 0,
                "audio_external_speaker_volume": 0,
                "audio_internal_mic_aec_enabled": true,
                "audio_internal_mic_boost": 0,
                "audio_internal_mic_volume": 0,
                "audio_internal_speaker_volume": 0,
                "audio_min_echo_amplitude": 0,
                "audio_playback_gain_percent": 0,
                "audio_record": true,
                "audio_supported": true,
                "audio_use_external_mic": true,
                "audio_use_external_speaker": true,
                "audio_use_internal_speaker": true,
                "bandwidth_reports_disabled": true,
                "blocked_debounce_time_ms": 0,
                "blocked_threshold": 0,
                "char_threshold": 0,
                "cloud_ai_smart_crop_enabled": true,
                "cloud_ai_stream_enabled": true,
                "core_event_upload_target": "0",
                "crossing_regions": [],
                "custom_events": true,
                "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
                "device_mic_enabled": true,
                "device_near_audio_silenced": true,
                "device_speaker_enabled": true,
                "dewarpMode": "NORMAL",
                "disabled_schedule": [],
                "disabled_schedule_inverted": true,
                "disabled_schedule_uuid": "AAAAAAAAAAAAAAAAAAAAAA",
                "dwell_reset_ttl_ms": 0,
                "dwell_time_ms": 0,
                "exposure_level": 0,
                "firmware_dev_settings": {},
                "fisheye_display_mode": "RAW",
                "floorplan_homography": [],
                "frontendEqualizerHighShelf": {},
                "frontendEqualizerLowShelf": {},
                "frontendEqualizerPeaking1": {},
                "frontendEqualizerPeaking2": {},
                "frontendEqualizerPeaking3": {},
                "frontendNoiseSuppression": true,
                "h265_realtime_encoding_enabled": true,
                "h265_vod_encoding_enabled": true,
                "hdr_enabled": true,
                "high_res_detection": true,
                "human_detection": true,
                "human_loitering": true,
                "human_loitering_settings": {},
                "img_brightness": 0,
                "img_contrast": 0,
                "img_saturation": 0,
                "img_sharpness": 0,
                "inactivity_settings": {},
                "lastModified": 0,
                "led_mode_blink_period_ms": 0,
                "led_mode_when_active": "LED_OFF",
                "led_mode_when_inactive": "LED_OFF",
                "led_stealth_mode": true,
                "lightweight_detection_disabled": true,
                "live_license_invalid": true,
                "max_detections_per_frame": 0,
                "media_ttl_minutes": 0,
                "metering_config": {},
                "motor_config": {},
                "mounting_direction": "DOWN",
                "night_exposure_level": 0,
                "night_img_brightness": 0,
                "night_img_contrast": 0,
                "night_img_saturation": 0,
                "night_img_sharpness": 0,
                "night_metering_config": {},
                "night_sensor_gain_max": 0,
                "night_shutter_time_max": 0,
                "night_shutter_time_min": 0,
                "object_search": true,
                "occupancy_count_high_threshold": 0,
                "occupancy_count_low_threshold": 0,
                "occupancy_counting": true,
                "on_demand_license_invalid": true,
                "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
                "people_tracking": true,
                "person_reidentification": true,
                "privacy_window_polygons": [],
                "privacy_windows": [],
                "ptz_config": {},
                "ptz_home": {},
                "record_on_motion": true,
                "region_for_occupancy": {},
                "region_of_interest": {},
                "region_of_interest_groups": [],
                "resolution": {},
                "rotation": 0,
                "rtsp_encoder": 0,
                "segment_max_bytes": 0,
                "sensor_gain_max": 0,
                "shared_fov": [],
                "shutter_time_max": 0,
                "shutter_time_min": 0,
                "snapshot_height": 0,
                "snapshot_interval_secs": 0,
                "snapshot_upload_target": "0",
                "storage_target_free_megabytes": 0,
                "storage_target_free_space_permyriad": 0,
                "thumbstrip_upload_target": "0",
                "tile_views": [],
                "upload_all_detections": true,
                "use_onboard_lpr": true,
                "vehicle_detection": true,
                "video_ai_disabled": true,
                "video_persist_disabled": true,
                "wdr_enabled": true,
                "wdr_strength": 0,
                "zero_motion_video_bitrate_percent": 0
              },
              "customizations": {
                "forceLowBandwidthOnAllCameras": false,
                "inactivityTimeout": 30
              }
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/partner/customizeClientDevice"))
            .header("x-auth-scheme", "partner-api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "customizations": {
    "forceLowBandwidthOnAllCameras": false,
    "inactivityTimeout": 30
  },
  "error": false,
  "errorCode": "<string>"
}

Response

200 OK

application/json · object

Response object containing the applied client device customization settings.

customizationsobject

Client-specific customization settings for partner management.

Show child attributes

forceLowBandwidthOnAllCamerasboolean | null

Whether to force low bandwidth on all cameras

Example: false

inactivityTimeoutinteger<int32> | null

Inactivity timeout in minutes

Example: 30

errorboolean | null

errorCodestring | null

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring | null

warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.