Partially update device

Partially update a device's name, configuration or set assignment. Returns the updated device.

Update semantics

  • A field that is omitted or sent as null is left unchanged.
  • configuration is not merged: when sent, it replaces the device's whole configuration object. For a Smart Label it must therefore include flightModeEnabled and reportConfiguration, plus every optional setting you want to keep.

Set assignment (setId)

  • If the device already has a configuration, setId is stored as provided. The set is not checked for existence and its configuration is not applied to the device.
  • If the device has no configuration yet, the set is validated (400 Bad Request if it does not exist) and the set's configuration is applied to the device.

BLE Tags

  • Only configuration can be updated, and it is required. Sending name or setId for a BLE Tag returns 400 Bad Request.
Path Params
string
required

The account ID associated with the device.

string
required

The device ID to be updated.

Body Params

Device fields to update.

Fields to update on a device. Omitted or null fields are left unchanged.

string | null
^[^\$\%\^\*\{\}\@]{0,70}$

Name of the device. Up to 70 characters; cannot contain $, %, ^, *, {, } or @. Not supported for BLE Tags.

uuid | null

ID of the set to assign the device to. See the operation description for how it is applied. Not supported for BLE Tags.

configuration

Replaces the device's whole configuration. Required for BLE Tags.

Responses

401

Unauthorized. The access token is missing, invalid or expired. Returned by the gateway with an empty body.

403

Forbidden. The caller lacks permission, or the account is unknown, belongs to another tenant or is inactive. Returned by the gateway with an empty body.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json