Update an asset

patch

https://api.safetyculture.io/assets/v1/assets/{id}

When you update an asset’s custom fields using this endpoint, include values for all custom fields associated with the asset. To update only some field values, use Set asset field values instead.

🚧
Include values for every existing custom field you want to keep. If a custom field is missing from the request, the value may be cleared.

Requirements

📘
If your organization uses site-based access for assets, the API only updates assets that the API token’s user can access through their site membership.

Path Params

string

required

The unique identifier of an asset. This ID is system-generated.

Body Params

Asset which replaces the one with matching identifier on the server.

code

string

The user-defined unique identifier of an asset. This ID is user-generated.

type

object

The asset type of an asset.

fields

array of objects

The associated fields of an asset contained in an array. Each asset's
fields are based on its asset type. Please make sure the asset fields you
use associated with the specified asset type. You can retrieve the
associated fields using the list type and field association endpoint.

fields

site

object

The assigned site of an asset as object. If an asset is not assigned to a
site, the API will return nil.

state

string

enum

Defaults to ASSET_STATE_UNSPECIFIED

The indicator for whether an asset is active or archived.

Allowed:

Responses

Requirements

200A successful response.

defaultAn unexpected error response.