Skip to main content
PATCH
Update an asset

Authorizations

Authorization
string
header
required

Path Parameters

asset_id
string
required

The asset's friendly ID (e.g. asset_aBcD1234eFgH5678).

Body

application/json
asset
object
required

Response

The updated asset.

id
string

The asset's friendly ID (e.g. asset_aBcD1234eFgH5678).

Example:

"asset_aBcD1234eFgH5678"

friendly_id
string

Same value as id.

Example:

"asset_aBcD1234eFgH5678"

name
string | null
health_status
enum<string> | null
Available options:
online,
status_unavailable,
null
location_id
string | null

The friendly ID of the asset's location, if any.

project_id
string | null

The friendly ID of the project the asset belongs to directly, if any. Assets can be scoped to a project directly, in addition to (or instead of) being linked through a location.

lat
string | null

Latitude in decimal degrees, from -90 to 90. Serialized as a string, as on locations.

long
string | null

Longitude in decimal degrees, from -180 to 180. Serialized as a string, as on locations.

custom_field_values
object

Custom field values keyed by the key of a custom field definition with object_type asset. Use GET /custom_field_definitions?object_type=asset&project_id={project_id} to discover the fields available to an asset in that project, with their value_type and enumeration_options; without project_id, only account-wide fields are listed. An empty object when none are set.

created_at
string<date-time>
updated_at
string<date-time>