Partially update asset

Update specific fields of an existing asset. Partial update: fields you omit are left unchanged, and a field sent as explicit null is cleared. Send the body as application/json. No field is required. Setting deviceId to null unpairs the current device; setting a different deviceId pairs that device instead and moves it to the asset's set. Changing setId moves the paired device to the new set; setting setId to null re-runs automatic set assignment.

Path Params
string
required

The account ID.

string
required

The asset ID.

Body Params

Asset fields to update.

Request data for creating or updating an asset. No field is required.

uuid | null

ID of a set in the account (400 if it does not exist).

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

Name. Up to 40 characters; cannot contain $ % ^ * { } @.

string | null

Description.

string | null
^[a-zA-Z0-9._\-\s]{0,70}$

ID of the paired device. Letters, numbers, spaces, dots, hyphens and underscores, up to 70 characters. The device must exist in the account (400).

string | null
enum

Health status. Closed cannot be set in a request (400); defaults to Healthy on create.

Allowed:
items
array of objects | null

Items (up to 10).

items
customProperties
object | null

Custom key-value properties: up to 30 keys, keys up to 50 characters, values up to 100 characters.

string | null
enum

Physical category of the asset.

tags
array of strings | null, unique

Tags (up to 15, each up to 30 characters).

tags
homeLocation
object | null

Home location of the asset (optional).

Responses

401

Missing, invalid or expired access token. Returned by the gateway with an empty body.

403

The token lacks the required permission, the account is not accessible to it, or the tenant 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