---
title: "Update an asset field"
method: PATCH
path: "/assets/v1/fields/{id}"
tags: ["Assets"]
---

# Update an asset field

`PATCH /assets/v1/fields/{id}`

## Request

- Base URL: `https://api.mitti.com`
- URL: `https://api.mitti.com/assets/v1/fields/{id}`
- Auth: HTTP bearer

## Path parameters

- `id` string, required

## Request body

- S12AssetsV1FieldsServiceUpdateFieldBody: The parameters for `UpdateField`
  - `field` object: Field which replaces the one with matching identifier on the server.
    - `name` string: Name of the field.
    - `field_type` 'FIELD_TYPE_UNSPECIFIED' | 'FIELD_TYPE_PREDEFINED' | 'FIELD_TYPE_CUSTOM': Type of Field. - FIELD_TYPE_UNSPECIFIED: Field type Unspecified. - FIELD_TYPE_PREDEFINED: Field type pre-defined. - FIELD_TYPE_CUSTOM: Field type custom.
    - `value_type` 'FIELD_VALUE_TYPE_UNSPECIFIED' | 'FIELD_VALUE_TYPE_STRING' | 'FIELD_VALUE_TYPE_MONEY' | 'FIELD_VALUE_TYPE_TIMESTAMP' | 'FIELD_VALUE_TYPE_SELECT': Describes each type of asset field. - FIELD_VALUE_TYPE_UNSPECIFIED: Field value type unspecified. - FIELD_VALUE_TYPE_STRING: This type accepts plain text values. - FIELD_VALUE_TYPE_MONEY: This type accepts numerical values with currency codes. For example, "99.99" numerical value with "AUD" as the currency code. - FIELD_VALUE_TYPE_TIMESTAMP: This type accepts timestamp values in the Internet Date-Time format. - FIELD_VALUE_TYPE_SELECT: This type accepts select values.
    - `select_options` S12TypefieldV1FieldOption[]: The options of a field select. 100 limit enforced in typefield, but to lower the feedback loop, we enforce it here too.
      - `id` string: The id of a field select option.
      - `label` string: The label of a field select option.
      - `order` integer: The display order of this option, 0-indexed. Options should be displayed in ascending order of this field, matching the order they were defined in the field settings.
  - `update_mask` string, required: REQUIRED. The attributes (such as name etc.) you want to update for the field, specified in the parameters. For example, the update_mask=name parameter indicates that only the name will be updated in a request, any other attributes provided in your request body will be ignored.

## Response `200`

A successful response.

- S12AssetsV1UpdateFieldResponse: Result returned from `UpdateField`
  - `field` S12AssetsV1Field: Field entity.
    - `id` string, required: A global unique identifier for a field.
    - `name` string: Name of the field.
    - `field_type` 'FIELD_TYPE_UNSPECIFIED' | 'FIELD_TYPE_PREDEFINED' | 'FIELD_TYPE_CUSTOM': Type of Field. - FIELD_TYPE_UNSPECIFIED: Field type Unspecified. - FIELD_TYPE_PREDEFINED: Field type pre-defined. - FIELD_TYPE_CUSTOM: Field type custom.
    - `value_type` 'FIELD_VALUE_TYPE_UNSPECIFIED' | 'FIELD_VALUE_TYPE_STRING' | 'FIELD_VALUE_TYPE_MONEY' | 'FIELD_VALUE_TYPE_TIMESTAMP' | 'FIELD_VALUE_TYPE_SELECT': Describes each type of asset field. - FIELD_VALUE_TYPE_UNSPECIFIED: Field value type unspecified. - FIELD_VALUE_TYPE_STRING: This type accepts plain text values. - FIELD_VALUE_TYPE_MONEY: This type accepts numerical values with currency codes. For example, "99.99" numerical value with "AUD" as the currency code. - FIELD_VALUE_TYPE_TIMESTAMP: This type accepts timestamp values in the Internet Date-Time format. - FIELD_VALUE_TYPE_SELECT: This type accepts select values.
    - `select_options` S12TypefieldV1FieldOption[]: The options of a field select. 100 limit enforced in typefield, but to lower the feedback loop, we enforce it here too.
      - `id` string: The id of a field select option.
      - `label` string: The label of a field select option.
      - `order` integer: The display order of this option, 0-indexed. Options should be displayed in ascending order of this field, matching the order they were defined in the field settings.

## Other responses

- `default`: An unexpected error response.

---

[API](https://skmtc.dev/safetyculture/apis/safetyculture-api.md) - [All operations](https://skmtc.dev/safetyculture/apis/safetyculture-api/llms.txt) - [OpenAPI document](https://skmtc.dev/safetyculture/apis/safetyculture-api/revisions/eb6bb843bf18?raw)
