Create asset

Register a new asset. No field is required; healthStatus defaults to Healthy. To pair a device, send its deviceId: the device must exist in the account and is moved to the asset's set. If you omit setId, the asset is assigned automatically to the set with the lowest priority (or, if no set has a priority, the first set without one). Returns 201 with the created asset; the Location header contains /v1/accounts/{accountId}/assets/{assetId}.

Path Params
string
required

The account ID.

Body Params

Asset details.

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