HubDevices

Update Device Record For Hub Device

Changed on

Updates a hub device record (Widget Backed)

patch/hubdevices/{hubDeviceId}/childdevice/{deviceId}

Request

Path parameters

hubDeviceIdstring ^(?:([0-9a-fA-F]{32})|([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}))$ required

The Hub's Device ID. This is sometimes referred to as the Hub UUID or HubId

deviceIdstring required

The Device ID

Query parameters

forceUpdateboolean

A flag that is used to indicate that the driver and profile should be updated even if the fingerprinting process fails. Additionally, forceUpdate is required when a new device integration profile key is provided in the request payload.

Headers

Authorizationstring string required

OAuth token

Request body

driverIdstring required

Unique Identifier of the driver

provisioningState'PROVISIONED' | 'TYPED' | 'DRIVER_SWITCH' | 'NONFUNCTIONAL'

Provisioning type for a widget device

Example request

{
  "driverId": "6d7bf35a-bb57-4b1f-945a-63ff72bfbef3"
}

Response

Successful creation of resource with no-content to return

Changes