Update an asset field

Update specific attributes of an existing asset field using the update_mask parameter to control which properties are modified.

  • If update_mask=name, only the name is updated regardless of other values in the request body.
  • If update_mask=select_options, only select options are updated.
  • Multiple attributes can be updated in one request using comma-separated values: update_mask=name,select_options.
  • Any attributes not listed in update_mask are ignored, even if present in the request body.

When updating select options:

  • New options can be added to the select_options array.
  • Existing options cannot be removed or modified (to preserve data integrity on existing assets).
  • Total options cannot exceed 100.
  • Each new option requires a unique id and label.

Requirements

🚧

Predefined fields (FIELD_TYPE_PREDEFINED) cannot be updated. Only custom fields (FIELD_TYPE_CUSTOM) created by your organization can be modified.

Path Params
string
required

A global unique identifier for a field.

Body Params

The parameters for UpdateField

field
object

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

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.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json