Update an asset

Updates asset fields such as assignee and ownership

Update Asset

patch

Update asset fields (employee assignment, ownership, etc.)

Authorizations

AuthorizationstringRequired

Harmony access key, sent as Authorization: AccessKey <your-key>. Create keys in Settings > Access Keys. The tenant is resolved from the key.

Path parameters

asset_idstringRequired

Body

Request for updating asset fields

namestring · max: 255 · nullableOptional

Asset display name

employee_idstring · nullableOptional

Employee ID to assign asset to. Use 'UNASSIGN' to explicitly unassign

ownershipstring · enum · nullableOptional

Asset ownership

Possible values:

statusstring · enum · nullableOptional

Asset lifecycle status

Possible values:

retirement_sub_statusstring · enum · nullableOptional

Retirement sub-status (only when status=RETIRED)

Possible values:

retirement_notesstring · nullableOptional

Custom notes for retirement disposition (required when retirement_sub_status=OTHER)

for_saleboolean · nullableOptional

Whether asset is for sale

location_manualstring · max: 255 · nullableOptional

User-entered physical location (e.g., 'Building A, Shelf 3'). Empty string to clear.

location_pinnedboolean · nullableOptional

Pin state of the manual location. Setting a new manual location pins it by default; re-sending the stored value leaves the pin state unchanged. Pass false alongside a value to leave it unpinned, or alone to unpin the current value. Pass true to pin the asset's existing manual location.

Responses

200

Successful Response

application/json

Response for successful asset update

messagestringOptionalDefault: Asset updated successfully

asset_idstringRequired

namestring · nullableOptional

employee_idstring · nullableOptional

ownershipstring · enum · nullableOptional

Asset ownership enumeration.

Possible values:

statusstring · enum · nullableOptional

Asset lifecycle status enumeration.

Possible values:

retirement_sub_statusstring · enum · nullableOptional

Sub-status for retired assets.

Possible values:

retirement_notesstring · nullableOptional

for_saleboolean · nullableOptional

422

Validation Error

application/json

patch/api/v1/assets/{asset_id}

PATCH /asset-management/api/v1/assets/{asset_id} HTTP/1.1
Host: api.harmony.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 293

{
  "name": "text",
  "employee_id": "text",
  "ownership": "COMPANY_OWNED",
  "status": "in_stock",
  "retirement_sub_status": "auto_detected",
  "retirement_notes": "text",
  "for_sale": true,
  "location_manual": "text",
  "location_pinned": true,
  "custom_fields": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
}

{
  "message": "Asset updated successfully",
  "asset_id": "text",
  "name": "text",
  "employee_id": "text",
  "ownership": "COMPANY_OWNED",
  "status": "in_stock",
  "retirement_sub_status": "auto_detected",
  "retirement_notes": "text",
  "for_sale": true
}