> ## Documentation index > Fetch the complete documentation index at: https://developer.rhombus.com/llms.txt > Use it to discover all available pages before exploring further. # Update partner user details > Update a partner's details with partner-specific validation and audit logging. ```http POST https://api2.rhombussystems.com/api/user/updatePartnerUser ``` EU organizations send the same request to `https://api2.eu.rhombussystems.com`. ## Authentication and parameters - `x-auth-apikey` (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). - `Authorization` (header): instead of an API key, an OAuth access token (`Bearer `) with the `write` scope. - `x-auth-scheme` (header, string, default: `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 ` 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. One of: `api-token`, `api`, `api-oauth-token`, `federated-token`, `partner-api-token`, `partner-api`, `partner-api-oauth-token`. - `x-auth-org` (header, string): 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`. ## Request body Content type: `application/json` - `bypassSaml` (boolean | null) - `mfaEnabled` (boolean | null) - `name` (string | null) - `notificationSettingsV2` (object) - `permissionGroupUuid` (string | null): base 64 (url-safe) uuid string - `smsPhoneNumbers` (array | null) - `summaryEmailEnabled` (boolean | null) - `userUuid` (string | null): base 64 (url-safe) uuid string ## Response 200 OK. Content type: `application/json` - `error` (boolean | null) - `errorCode` (string | null): Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg. - `errorMsg` (string | null) - `warningMsg` (string | null) ## Errors Also 400, 401, 403, 429, 500, 503 with the standard error body (`errorCode`, `errorMsg`): https://developer.rhombus.com/errors ## OpenAPI ````yaml openapi: 3.0.1 info: title: Rhombus API version: "1.0" servers: - description: Production Server url: https://api2.rhombussystems.com security: - ApiKeyAuth: [] paths: /api/user/updatePartnerUser: post: description: Update a partner's details with partner-specific validation and audit logging. operationId: updatePartnerUser parameters: - description: "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 ` 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." example: partner-api-token in: header name: x-auth-scheme required: false schema: default: partner-api-token enum: - api-token - api - api-oauth-token - federated-token - partner-api-token - partner-api - partner-api-oauth-token type: string - description: "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`." in: header name: x-auth-org required: false schema: format: RUUID maxLength: 22 minLength: 22 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/User_UpdatePartnerWSRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/User_UpdatePartnerWSResponse" description: OK "400": $ref: "#/components/responses/BadRequest" "401": $ref: "#/components/responses/Unauthorized" "403": $ref: "#/components/responses/Forbidden" "429": $ref: "#/components/responses/TooManyRequests" "500": $ref: "#/components/responses/InternalServerError" "503": $ref: "#/components/responses/ServiceUnavailable" security: - ApiKeyAuth: [] - oauth2: - write summary: Update partner user details tags: - User Webservice components: schemas: User_UpdatePartnerWSRequest: properties: bypassSaml: nullable: true type: boolean mfaEnabled: nullable: true type: boolean name: nullable: true type: string notificationSettingsV2: $ref: "#/components/schemas/PartnerNotificationSettingsV2" permissionGroupUuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string smsPhoneNumbers: items: nullable: true type: string nullable: true type: array summaryEmailEnabled: nullable: true type: boolean userUuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string type: object PartnerNotificationSettingsV2: properties: allClientsSelected: nullable: true type: boolean clientNotificationIntervalsMap: additionalProperties: items: $ref: "#/components/schemas/PartnerNotificationClientSection" nullable: true type: array nullable: true type: object notificationIntervalsForAllClients: items: $ref: "#/components/schemas/PartnerNotificationClientSection" nullable: true type: array orgUuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string smsNotificationIncludesLinks: nullable: true type: boolean smsPhoneNumbers: items: nullable: true type: string nullable: true type: array summaryEmailEnabled: nullable: true type: boolean userUuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string type: object PartnerNotificationClientSection: properties: clientUuids: items: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string nullable: true type: array uniqueItems: true rows: items: $ref: "#/components/schemas/PartnerNotificationClientSectionRow" nullable: true type: array type: object PartnerNotificationClientSectionRow: properties: activities: items: $ref: "#/components/schemas/ActivityEnum" nullable: true type: array uniqueItems: true days: items: $ref: "#/components/schemas/RhombusDayOfWeekEnum" nullable: true type: array uniqueItems: true diagnostics: items: $ref: "#/components/schemas/DiagnosticActivityEnum" nullable: true type: array uniqueItems: true interval: $ref: "#/components/schemas/MinuteOfDayIntervalType" mediums: items: $ref: "#/components/schemas/NotificationEnumType" nullable: true type: array uniqueItems: true type: object ActivityEnum: enum: - SOUND_LOUD - SOUND_GUN_SHOT - TAMPER - VISUAL_TAMPER - MOTION_TAMPER - MOTION - MOTION_HUMAN - MOTION_CAR - MOTION_ANIMAL - MOTION_PACKAGE - PACKAGE_ARRIVED - PACKAGE_DEPARTED - FACE - FACE_IDENTIFIED - FACE_UNIDENTIFIED - FACE_BLACKLISTED - FACE_ALERT - POSE_ANOMALOUS - POSE_FALL - LICENSEPLATE - LICENSEPLATE_IDENTIFIED - LICENSEPLATE_UNIDENTIFIED - LICENSEPLATE_ALERT - LICENSEPLATE_BLACKLISTED - LICENSEPLATE_TRUSTED - PEOPLECOUNT_HIGH - PEOPLECOUNT_HIGH_RESET - PEOPLECOUNT_LOW - PEOPLECOUNT_LOW_RESET - HUMAN_ENTER - HUMAN_EXIT - CAR_ENTER - CAR_EXIT - TEMPERATURE_EXCEEDED_HIGH - TEMPERATURE_EXCEEDED_LOW - HUMIDITY_EXCEEDED_HIGH - HUMIDITY_EXCEEDED_LOW - PM25_EXCEEDED_HIGH - TVOC_EXCEEDED_HIGH - ETOH_EXCEEDED_HIGH - IAQ_EXCEEDED_HIGH - CO2_EXCEEDED_HIGH - CO2_EXCEEDED_LOW - PROBE_TEMPERATURE_EXCEEDED_HIGH - PROBE_TEMPERATURE_EXCEEDED_LOW - PROBE_DISCONNECTED - PROBE_CONNECTED - HEAT_INDEX_EXCEEDED_HIGH - PRESSURE_EXCEEDED_HIGH - PRESSURE_EXCEEDED_LOW - PM10_EXCEEDED_HIGH - PM40_EXCEEDED_HIGH - PM100_EXCEEDED_HIGH - VOC_IDX_EXCEEDED_HIGH - NOX_IDX_EXCEEDED_HIGH - FORMALDEHYDE_EXCEEDED_HIGH - CARBON_MONOXIDE_EXCEEDED_HIGH - AQI_EXCEEDED_HIGH - DOOR_AJAR - DOOR_OPENED - DOOR_CLOSED - BUTTON_SINGLE_PRESSED - BUTTON_DOUBLE_PRESSED - BUTTON_LONG_PRESSED - TAG_ARRIVED - TAG_DEPARTED - TAG_MOVED - TAG_POSITIONING_CHANGED - TAG_BOUNDARY_INGRESS - TAG_BOUNDARY_EGRESS - TAG_PANIC - BADGE_AUTHORIZED - BADGE_UNAUTHORIZED - BADGE_UNAUTHORIZED_V2 - BADGE_AJAR - BADGE_MANUAL - BADGE_FORCED_OPEN - BADGE_LOCKDOWN - BADGE_REQUEST_TO_EXIT - BADGE_DURESS - BADGE_SECURITY_BREACH - BADGE_TAMPER - BADGE_FACE_MISMATCH - POS_ORDER - GUN_DETECT_EVENT - IOT_SOUND_AGGRESSION - IOT_SOUND_HELP - IOT_AIR_CO - IOT_AIR_CO2 - IOT_AIR_MASKING - IOT_AIR_THC - IOT_AIR_VAPE - IOT_AIR_VOC - IOT_AIR_TEMP - IOT_TAMPER - IOT_GUNSHOT - IOT_BUTTON_SINGLE_CLICK - IOT_BUTTON_DOUBLE_CLICK - IOT_BUTTON_HOLD - IOT_PANIC_BUTTON_TRIGGERED - AUDIO_SOUND_SIGNIFICANT - AUDIO_SOUND_LOUD - AUDIO_SOUND_ABUSIVE - AUDIO_SOUND_GREETING - AUDIO_SOUND_HELP - AUDIO_SOUND_GUN - AUDIO_SOUND_GLASS_BREAK - AUDIO_SOUND_ALARM_SMOKE_FIRE - AUDIO_SOUND_ALARM_CARBON_MONOXIDE - AUDIO_SOUND_SIREN - CLIMATE_VOC - CLIMATE_VAPE - CLIMATE_SMOKE - CLIMATE_THC - CLIMATE_CO2 - CLIMATE_ETOH - CLIMATE_PM25 - CLIMATE_IAQ - CLIMATE_LEAK - SOUND_AGGRESSION - SOUND_HELP - AIR_CO - AIR_CO2 - AIR_MASKING - AIR_THC - AIR_VAPE - AIR_VOC - MASK_MISSING - HELMET_MISSING - GLOVES_MISSING - PIR_OCCUPIED - PIR_MOVEMENT - PIR_VACANT - CUSTOM - VISITOR_ARRIVED - VISITOR_DEPARTED - AC_DR_CONNECTED - AC_DR_DISCONNECTED - AC_DPI_DOOR_OPEN - AC_DPI_DOOR_CLOSED - AC_DPI_DOOR_AJAR - AC_DPI_DOOR_FORCED_OPEN - AC_DSR_UNLOCKED - AC_DSR_LOCKED - AC_DB_TRIGGERED - AC_PANIC_BUTTON_TRIGGERED - AC_REMOTE_UNLOCK - AC_BADGE_AUTHORIZED - AC_BADGE_UNAUTHORIZED - AC_BADGE_FACE_MISMATCH - AC_LOCKDOWN_ACTIVATED - AC_LOCKDOWN_DEACTIVATED - AC_LOCKDOWN_PLAN_SWITCHED - AC_TAMPER_PROX - AC_TAMPER_ACCEL - AC_TAMPER_SWITCH - AC_GR_ACTIVE - AC_GR_INACTIVE - AC_GI_ACTIVE - AC_GI_INACTIVE - AC_REX_ACTIVE - AC_REX_INACTIVE - AC_APERIO_DEVICE_DISCONNECTED - AC_APERIO_DEVICE_CONNECTED - AC_APERIO_DEVICE_REBOOT - AC_APERIO_DEVICE_TAMPER - AC_APERIO_LOW_BATTERY - AC_APERIO_FLAT_BATTERY - AC_APERIO_OK_BATTERY - AC_SCHLAGE_GW_DISCONNECTED - AC_SCHLAGE_GW_CONNECTED - AC_SCHLAGE_APM_DISCONNECTED - AC_SCHLAGE_APM_CONNECTED - AC_SCHLAGE_LOW_BATTERY - AC_SCHLAGE_CRITICAL_BATTERY - AC_SCHLAGE_OK_BATTERY - POWER_SWITCH_BATTERY - POWER_SWITCH_PRIMARY - AI_SEARCH_MATCH - AI_SEARCH_MATCH_PERSON_SMOKING - AI_SEARCH_MATCH_PERSON_ON_PHONE - AI_SEARCH_MATCH_PERSON_FALLING - CUSTOM_LLM_BOOLEAN_TRUE - CUSTOM_LLM_BOOLEAN_FALSE - CUSTOM_LLM_THRESHOLD_EXCEEDED_LOW - CUSTOM_LLM_THRESHOLD_EXCEEDED_HIGH - ALM_AUTHORITIES_CONTACTED - ALM_MONITORING_ENABLED - ALM_MONITORING_DISABLED - ALM_MONITORING_SETTINGS_CHANGE - ALM_THREAT_CASE_CLOSED - ALM_THREAT_DETECTED - ALM_MONITORING_EVENT_DETECTED - ROBOT_DOG_DETECTED - ROBOT_ARRIVED_AT_WAYPOINT - ROBOT_ARRIVED_AT_POSE - ROBOT_WAITING_AT_POSE - ROBOT_MANUAL_CMD_VEL - ROBOT_MANUAL_ACTION - ROBOT_MANUAL_POSTURE - ROBOT_NAVIGATE_TO_POSE_START - ROBOT_NAVIGATE_TO_POSE_END - ROBOT_NAVIGATE_TO_HOME_START - ROBOT_NAVIGATE_TO_HOME_END - ROBOT_NAVIGATE_TO_WAYPOINT_START - ROBOT_NAVIGATE_TO_WAYPOINT_END - ROBOT_ROUTE_RUN_START - ROBOT_ROUTE_RUN_END - ROBOT_LOW_BATTERY_DOCKING - ROBOT_IDLE_DOCKING - ROBOT_EMERGENCY - LOITER_HUMAN - INACTIVITY_HUMAN - INACTIVITY_CAR - GROUP_ENTRY - ONGUARD_BADGE_AUTHORIZED - ONGUARD_BADGE_ANOMALY - ONGUARD_NO_ENTRY_MADE - ELEMENTS_BADGE_AUTHORIZED - ELEMENTS_BADGE_ANOMALY - ELEMENTS_NO_ENTRY_MADE - NETBOX_BADGE_AUTHORIZED - NETBOX_BADGE_ANOMALY - NETBOX_NO_ENTRY_MADE - THERMAL_TEMPERATURE_ALARM - THERMAL_TEMPERATURE_WARNING - THERMAL_FIRE_DETECTED - THERMAL_SMOKING_DETECTED - THERMAL_FIRE_VERIFIED - THERMAL_HEAT_NO_THREAT - THERMAL_VISUAL_HOTSPOT - THERMAL_VISUAL_HEAT_RISE - THERMAL_VISUAL_WARM_BODY - UNKNOWN type: string RhombusDayOfWeekEnum: enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY type: string DiagnosticActivityEnum: enum: - CAMERA_CONNECTED - CAMERA_DISCONNECTED - STARTUP - GATEWAY_CONNECTED - GATEWAY_DISCONNECTED - UPDATE_STARTED - UPDATE_FIRMWARE_DOWNLOADED - UPDATE_FIRMWARE_APPLIED - UPDATE_STARTING_REBOOT - UPDATE_FAILED_MD5_MISMATCH - UPDATE_FAILED_ACCESS_DENIED - UPDATE_FAILED_MITM - UPDATE_FAILED_CONNNECTION_REFUSED - UPDATE_FAILED_CONNNECTION_TIMEOUT - UPDATE_FAILED_CONNECTION_REFUSED - UPDATE_FAILED_CONNECTION_TIMEOUT - UPDATE_FAILED_DNS_FAILURE - UPDATE_RUNNING - UPDATE_HALTED_FOR_INVESTIGATION - UPDATE_HALT_CLEARED - UPDATE_HALT_STATE_ACTIVE - UPDATE_REFUSED_HALTED - BLE_CONNECTED - BLE_CONNECTION_FAILED - BLE_DISCONNECTED - BLE_OP_SUCCESS - BLE_OP_FAILURE - UPLOAD_CLIP_SUCCESS - UPLOAD_CLIP_FAILURE - NOTIFICATION_FAILURE - USB_FAILURE_REBOOT - PERSISTENT_STORAGE_FAILURE - PING - FORCED_REBOOT - AUTO_REBOOT - AUDIO_HARDWARE_NOT_DETECTED - ENCRYPTED_CONTAINER_FAILURE_CREATE - ENCRYPTED_CONTAINER_FAILURE_OPEN - ENCRYPTED_CONTAINER_FAILURE_MOUNT - VIDEO_HARDWARE_FAILURE - WIFI_NETWORK_CHANGED - AI_ENGINE_DOWNLOADED - AI_ENGINE_DOWNLOAD_FAILED_MD5_MISMATCH - AI_ENGINE_CONFIGURED - AI_ENGINE_CONFIGURATION_FAILED - MITM_FAILURE - SERVER_RECONNECT - AP_CHANGED - WATCHDOG_KILLED_AGENT - WATCHDOG_DID_RESET - CLIMATE_OFFLINE - CLIMATE_ONLINE - CLIMATE_LOW_BATTERY - CLIMATE_PROBE_CONNECTED - CLIMATE_PROBE_DISCONNECTED - DOOR_OFFLINE - DOOR_ONLINE - DOOR_LOW_BATTERY - OCCUPANCY_SENSOR_ONLINE - OCCUPANCY_SENSOR_OFFLINE - OCCUPANCY_SENSOR_LOW_BATTERY - BUTTON_OFFLINE - BUTTON_ONLINE - BUTTON_LOW_BATTERY - PROXIMITY_LOW_BATTERY - ROBOT_LOW_BATTERY - DOOR_CONTROLLER_CONNECTED - DOOR_CONTROLLER_DISCONNECTED - APERIO_LOW_BATTERY - APERIO_FLAT_BATTERY - APERIO_OK_BATTERY - APERIO_GW_CONNECTED - APERIO_GW_DISCONNECTED - APERIO_DEVICE_CONNECTED - APERIO_DEVICE_DISCONNECTED - SCHLAGE_LOW_BATTERY - SCHLAGE_CRITICAL_BATTERY - SCHLAGE_OK_BATTERY - SCHLAGE_GW_CONNECTED - SCHLAGE_GW_DISCONNECTED - SCHLAGE_APM_CONNECTED - SCHLAGE_APM_DISCONNECTED - BADGE_READER_CONNECTED - BADGE_READER_DISCONNECTED - REBOOT - NETWORK_INTERRUPTION - OPENPATH_WEBHOOK_FAILURE - TOAST_WEBHOOK_FAILURE - KISI_WEBHOOK_FAILURE - BRIVO_WEBHOOK_FAILURE - HALO_WEBHOOK_FAILURE - SALTO_WEBHOOK_FAILURE - SQUARE_WEBHOOK_FAILURE - BUTTERFLYMX_WEBHOOK_FAILURE - ENVOY_WEBHOOK_FAILURE - GENEA_WEBHOOK_FAILURE - PRODATAKEY_WEBHOOK_FAILURE - AMT_WEBHOOK_FAILURE - PLACEOS_WEBHOOK_FAILURE - OMNIALERT_WEBHOOK_FAILURE - FLIC_WEBHOOK_FAILURE - SHELLY_WEBHOOK_FAILURE - PIMLOC_WEBHOOK_FAILURE - NINEONEONECELLULAR_WEBHOOK_FAILURE - HONEYWELL_ELEMENTS_WEBHOOK_FAILURE - HONEYWELL_ONGUARD_WEBHOOK_FAILURE - TRITON_WEBHOOK_FAILURE - EXTERNAL_WEBHOOK_FAILURE - VOICE_CALL_INITIATED - VOICE_CALL_ANSWERED - VOICE_CALL_REJECTED_AS_MACHINE - VOICE_CALL_COMPLETED - VOICE_CALL_NO_ANSWER - VOICE_CALL_FAILED - VOICE_CALL_SKIPPED - CV_FAILURE - NFC_HW_FAILURE - CONFIG_ERROR - HW_FAILURE - BLE_HW_RECOVERED - BLE_HW_FAILURE - KEYPAD_ONLINE - KEYPAD_OFFLINE - ALM_OVERAGE_APPROACHING - ALM_OVERAGE_REACHED - ALM_OVERAGE_EXCEEDED - ALM_EXCESSIVE_VERIFICATIONS - KIOSK_OFFLINE - KIOSK_ONLINE - TUNNELED_DEVICE_CONNECTED - TUNNELED_DEVICE_DISCONNECTED - SD_CARD_CHANGED - SD_CARD_NOT_FOUND - SUPERVISION_CUT_DETECTED - SUPERVISION_SHORT_DETECTED - SUPERVISION_INVALID_SETUP - THIRD_PARTY_DEVICE_CONNECTED - THIRD_PARTY_DEVICE_DISCONNECTED - NVR_STREAMING_STATUS - STORAGE_SM - DEVICE_OFFLINE_EXTENDED - DEVICE_OFFLINE_RECOVERED - DEVICES_OFFLINE_THRESHOLD - CLOUD_ARCHIVE_LAGGING - CLOUD_ARCHIVE_RECOVERED - LOCAL_RECORDING_INTERRUPTED - LOCAL_RECORDING_RECOVERED - UNKNOWN type: string MinuteOfDayIntervalType: properties: dayOfWeek: format: int32 nullable: true type: integer minuteOfDayStartInclusive: format: int32 nullable: true type: integer minuteOfDayStopExclusive: format: int32 nullable: true type: integer type: object NotificationEnumType: enum: - SMS - EMAIL - APP - SLACK - MICROSOFT_TEAMS - BROWSER - UNKNOWN type: string User_UpdatePartnerWSResponse: properties: error: nullable: true type: boolean errorCode: description: Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg. nullable: true type: string errorMsg: nullable: true type: string warningMsg: nullable: true type: string type: object securitySchemes: ApiKeyAuth: description: Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints). in: header name: x-auth-apikey type: apiKey oauth2: description: 'OAuth 2.0 authorization code flow with PKCE (`S256`). Send the access token as `Authorization: Bearer `. Each operation lists the scopes it requires; a token without them is refused 403 with `WWW-Authenticate: Bearer error="insufficient_scope"`.' flows: authorizationCode: authorizationUrl: https://console.rhombus.com/oauth/authorize refreshUrl: https://auth-web.rhombussystems.com/oauth/token scopes: physical: Unlock doors and elevators, lockdown, alarms, speakers and robots read: View cameras, footage and settings write: Change settings and data tokenUrl: https://auth-web.rhombussystems.com/oauth/token type: oauth2 ````