Anchor to section titled 'undefined'

MetafieldDefinitionInput
input_object

The input fields required to create a metafield definition.


The access settings that apply to each of the metafields that belong to the metafield definition.

The description for the metafield definition.

The unique identifier for the metafield definition within its namespace.

Must be 3-64 characters long and only contain alphanumeric, hyphen, and underscore characters.

The human-readable name for the metafield definition.

The container for a group of metafields that the metafield definition will be associated with. If omitted, the app-reserved namespace will be used.

Must be 3-255 characters long and only contain alphanumeric, hyphen, and underscore characters.

The resource type that the metafield definition is attached to.

Whether to pin the metafield definition.

The type of data that each of the metafields that belong to the metafield definition will store. Refer to the list of supported types.

A list of validation options for the metafields that belong to the metafield definition. For example, for a metafield definition with the type date, you can set a minimum date validation so that each of the metafields that belong to it can only store dates after the specified minimum.


Was this section helpful?


Was this section helpful?