Update Asset

Update fields on an existing asset.

PUT
/api/v1/assets/{id}

Description

Send only the fields you want to change. Field names match Add Asset.

If you set asset_status to In Use, include assign_to_email. Send an empty assign_to_email to remove the current assignment.

Device detail fields may be sent at the top level or inside a specifications object.

Optional custom_fields updates stored values for the fields you include. Match field_label values from GET /api/v1/assets/custom-fields.

custom_fields[].value accepts string, number, or boolean (stored as a string). Send empty string or null to clear a previously stored value. For currency fields, send the amount only or { "amount": "..." }; currency is fixed on the field definition.

Fields with is_readonly true cannot be set; including them returns 422.

Request

Headers

HeaderValueRequired
AuthorizationBearer <access_token>Yes
Content-Typeapplication/jsonYes

Path Parameters

ParameterTypeRequiredDescription
idstringYesSerial number, customer asset ID, internal asset ID, or asset number.

Body Parameters

ParameterTypeRequiredExampleDescription
product_typestringNoLaptopDevice category (e.g. Laptop, Desktop, Smartphone, Monitor, Printer).
product_namestringNoMacBook Pro 14Product name or model title.
manufacturerstringNoAppleBrand or manufacturer.
serial_numberstringNoC02XK1ABCDEFDevice serial number (must be unique per company).
asset_statusstringNoIn UseCurrent status. Must match a status configured for your company. Common values: Ready to Deploy, In Use, Unprovisioned, Lost/Stolen, Faulty, Recycled, Pending Recovery, Pending, Pending Processing, In Processing, Awaiting Action, Processing Started, Resolved, Under Review, Open, Disposed, Available, Assigned, Faulty, In Use, Retired.
model_numberstringNoA2338Manufacturer model identifier.
skustringNoMBP-16-2021Stock keeping unit. Cannot be a parent SKU with product variants.
asset_idstringNoIT-1234-ABCDCustomer asset ID. Alias: customer_asset_id.
conditionstringNoGoodNew, Good, Fair, or Poor.
purchase_datestringNo2023-01-15Purchase date (YYYY-MM-DD).
purchase_costnumberNo1999.99Acquisition cost. Alias: price.
purchase_typestringNoLeasedLeased, Owned, Financed, or Rented.
warranty_startstringNo2023-01-15Warranty start date.
warranty_expirestringNo2025-01-14Warranty end date (must be after warranty_start).
warranty_typestringNoManufacturerWarranty type: Manufacturer or Extended.
assign_to_emailstringNo[email protected]Employee work email. Required when asset_status is In Use.
departmentstringNoITDepartment name. Created automatically if it does not exist.
location_namestringNoHeadquartersWhere the device is stored or used (e.g. office name).
vendorstringNoCDWVendor or supplier name. Must already exist in your company settings.
descriptionstringNoEngineering team laptopFree-text asset notes.
end_of_lifestringNo2028-06-01Planned end-of-life date (YYYY-MM-DD).
custom_fieldsarrayNoManage-app custom field values. Use Custom Field List to discover field labels. File-type and read-only fields are not writable via API.

Laptop / Desktop specifications

Applicable when product_type is Laptop or Desktop.

Fields

ParameterTypeRequiredExampleDescription
processor_namestringNoApple M3 ProCPU / processor.
memorystringNo16 GBRAM.
storagestringNo512 GB SSDStorage capacity.
osstringNomacOS 14Operating system.
mac_addressstringNo00:1A:2B:3C:4D:5EMAC address.
ip_addressstringNo192.168.1.42IP address.
encryptionstringNoFileVaultDisk encryption status or type.
antivirusstringNoInstalledWhether antivirus is Installed or not Installed.

Smartphone / Tablet specifications

Applicable when product_type is Smartphone or Tablet.

Fields

ParameterTypeRequiredExampleDescription
storagestringNo256 GBStorage capacity.
osstringNoiOS 17Operating system.
imeistringNo356938035643809Primary IMEI (must be unique per company).
imei2stringNo356938035643817Secondary IMEI (must be unique per company).
mac_addressstringNo00:1A:2B:3C:4D:5EMAC address.
mdm_statusstringNoEnrolledMDM enrollment status.

Monitor specifications

Applicable when product_type is Monitor.

Fields

ParameterTypeRequiredExampleDescription
screen_sizestringNo27"Display size.
resolutionstringNo2560x1440Screen resolution.
aspect_ratiostringNo16:9Aspect ratio.

Printer specifications

Applicable when product_type is Printer.

Fields

ParameterTypeRequiredExampleDescription
print_resolutionstringNo1200x1200 dpiPrint resolution.
printer_typestringNoLaserPrinter technology type.

Each object in custom_fields[]

Optional. Send only the custom fields you want to update. An empty or null value clears the stored value for that field.

Fields

ParameterTypeRequiredExampleDescription
field_labelstringNoCost CenterCustom field label from Custom Field List.
valuestring | number | boolean | object | nullNoCost Center AAccepted as string, number, boolean, or object; stored as a string. Prefer strings. Checkbox may use true/false. Multiselect must be a comma-separated string. Currency fields accept the numeric amount only (e.g. "1500.00") or an object with amount (e.g. { "amount": "1500.00" }); the currency code is fixed on the field definition and cannot be overridden. Required when the definition is required for this product type. Send empty string or null to clear on update.

Example Request Body

{
  "asset_status": "In Use",
  "assign_to_email": "[email protected]",
  "condition": "Good",
  "memory": "32 GB",
  "antivirus": "Installed",
  "warranty_type": "Extended",
  "description": "Upgraded RAM",
  "custom_fields": [
    {
      "field_label": "Cost Center",
      "value": "Cost Center B"
    }
  ]
}

Response

FieldTypeDescription
messagestringHuman-readable confirmation.

Related Endpoints

Did this page help you?