Create an asset field

Create a custom field that can be used across assets in your organization. After creating a field, associate it with asset types using the Update an asset type endpoint.

Field value types

Choose the appropriate value type for your field:

  • String: This field type allows you to limit input to text only. Users can enter details like serial numbers, descriptions, or notes.
  • Money: This field type allows you to limit input to monetary values. It is ideal for logging cost, purchase price, and more. Currency values are displayed with up to two decimal points, except for currencies following a zero-decimal or three-decimal standard.
  • Timestamp: This field type allows users to select a date. It is helpful in tracking purchase dates, expiration dates, and other similar dates.
  • Select: This field type allows you to set a predefined list of options (requires select_options). Users can select just one option, such as vehicle color or fuel source.

Select fields

When creating a select field (FIELD_VALUE_TYPE_SELECT):

  • You must provide select_options with at least one option.
  • Each option requires an id and label.
  • Maximum 100 options per field.
  • Options cannot be removed after creation.

Requirements

🚧

Creating a field does not automatically make it available on assets. You must associate the field with specific asset types using the Update asset type and field association endpoint before it can be used. Alternatively, you can edit your asset type fields via the web app.

Body Params

The parameters for CreateField

The parameters for CreateField

string

Name of the field.

string
enum
Defaults to FIELD_VALUE_TYPE_UNSPECIFIED

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.
Allowed:
select_options
array of objects

Optional. The options of a field select.
100 limit enforced in typefield, but to lower the feedback loop, we enforce it here too.

select_options
Responses

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