Skip to main content
PATCH
Update an asset

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required
Example:

"ha_b7q2m1k8v4n0x3c9l5p2r7td"

Body

application/json

A field you leave out stays as it is, and null clears it. The type data object and metadata merge key by key. Unknown fields inside the type data object, and type data for another type, are rejected. Unknown top-level fields are ignored. A different device is a new asset: add it and decommission the old one.

parent_inverter
string | null

The Nomos ID of the active inverter in the same household that the asset sits behind. Required on solar, optional on battery (a battery without it is AC-coupled), not allowed on other types.

Example:

"ha_i9k3l7w2e5r8t1y4u6o0p3as"

is_steerable
boolean
manufacturer
string | null
model
string | null
installed_at
string<date-time> | null
metadata
object | null
inverter
object
solar
object
battery
object
wallbox
object
heat_pump
object

Response

The updated asset

A device in a household, or one of the two assets Nomos creates per household. It carries the type data object named like its type, with every field present and null where unknown.

object
enum<string>
required
Available options:
asset
id
string
required
Example:

"ha_b7q2m1k8v4n0x3c9l5p2r7td"

household
string
required
Example:

"dom_k3v9x2m7n1b4v8c2x6z0q5wd"

parent_inverter
string | null
required

The Nomos ID of the inverter the asset sits behind. Set on solar and on a battery behind a hybrid inverter.

Example:

"ha_i9k3l7w2e5r8t1y4u6o0p3as"

external_id
string | null
required

Your own ID. Null on household_net and household_residual.

Example:

"partner-bat-1"

status
enum<string>
required

A decommissioned asset stays readable, by its ID and in the list.

Available options:
active,
decommissioned
Example:

"active"

is_steerable
boolean
required
Example:

true

manufacturer
string | null
required
Example:

"BYD"

model
string | null
required
Example:

"Battery-Box Premium HVS 10.2"

installed_at
required
Example:

null

metadata
object | null
required
Example:
decommissioned_at
required
Example:

null

created_at
required
Example:

"2026-10-06T09:12:44Z"

type
enum<string>
required
Available options:
battery
battery
object
required