Update Asset | Coperniq API

Update an existing asset. All fields are optional — only include what you want to change.

siteId and accountId cannot be changed after creation. Including either field in the request body is rejected with a 400 Bad Request validation error.

To archive an asset, set isArchived: true. To unarchive, set isArchived: false.

Update an existing asset. All fields are optional — only include what you want to change. `siteId` and `accountId` cannot be changed after creation. Including either field in the request body is rejected with a `400 Bad Request` validation error. To archive an asset, set `isArchived: true`. To unarchive, set `isArchived: false`.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

assetIdstringRequired

Request

This endpoint expects an object.

namestringOptional

typeenumOptional

Asset type enum.

statusenumOptional

Asset lifecycle status.

Allowed values:

manufacturerstringOptional

modelstringOptional

serialNumberstringOptional

sizedoubleOptional

labelIdslist of integersOptional

Replaces the asset's label list.

installDatestring or nullOptionalformat: "date"

manufacturingDatestring or nullOptionalformat: "date"

expectedLifetimedoubleOptional

Expected lifetime in years

descriptionstringOptional

coverImageFileIdintegerOptional

nameplateImageFileIdintegerOptional

isArchivedbooleanOptional

Response

Asset updated successfully

idinteger

Asset identifier.

statusenum

Asset lifecycle status.

Allowed values:

siteIdinteger

labelslist of objects

Labels attached to the asset, ordered by position.

isArchivedboolean

uidinteger or null

Short human-readable identifier for the asset (nullable for older records).

namestring or null

typeenum or null

Asset type enum.

manufacturerstring or null

modelstring or null

serialNumberstring or null

accountIdinteger or null

ID of the account (project with type ACCOUNT) the asset belongs to.

sizedouble or null

installDatestring or nullformat: "date"

manufacturingDatestring or nullformat: "date"

expectedLifetimedouble or null

Expected lifetime in years

descriptionstring or null

coverImageFileIdinteger or null

nameplateImageFileIdinteger or null

createdAtstringformat: "date-time"

updatedAtstringformat: "date-time"

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

1	const url = 'https://api.coperniq.io/v1/assets/assetId';
2	const options = {
3	method: 'PATCH',
4	headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
5	body: '{}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}

1	{
2	"id": 1,
3	"status": "DRAFT",
4	"siteId": 1,
5	"labels": [
6	{
7	"id": 1,
8	"name": "string",
9	"type": "ASSET",
10	"color": "string"
11	}
12	],
13	"isArchived": true,
14	"uid": 1,
15	"name": "string",
16	"type": "BATTERY_SYSTEM",
17	"manufacturer": "string",
18	"model": "string",
19	"serialNumber": "string",
20	"accountId": 1,
21	"size": 1.1,
22	"installDate": "2023-01-15",
23	"manufacturingDate": "2023-01-15",
24	"expectedLifetime": 1.1,
25	"description": "string",
26	"coverImageFileId": 1,
27	"nameplateImageFileId": 1,
28	"createdAt": "2024-01-15T09:30:00Z",
29	"updatedAt": "2024-01-15T09:30:00Z"
30	}