Home > @infiniteobjects/shopify-data-manager > AdminTypes > MetafieldDefinitionUpdateInput
The input fields required to update a metafield definition.
Signature:
export interface MetafieldDefinitionUpdateInput
| Property | Modifiers | Type | Description |
|---|---|---|---|
| access? | InputMaybe<MetafieldAccessUpdateInput> | (Optional) The access settings that apply to each of the metafields that belong to the metafield definition. | |
| description? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) The description for the metafield definition. | |
| key | Scalars[‘String’][‘input’] | The unique identifier for the metafield definition within its namespace. Used to help identify the metafield definition, but can’t be updated itself. | |
| name? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) The human-readable name for the metafield definition. | |
| namespace? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) The container for a group of metafields that the metafield definition is associated with. Used to help identify the metafield definition, but cannot be updated itself. If omitted, the app-reserved namespace will be used. | |
| ownerType | MetafieldOwnerType | `${MetafieldOwnerType}` | The resource type that the metafield definition is attached to. Used to help identify the metafield definition, but can’t be updated itself. | |
| pin? | InputMaybe<Scalars[‘Boolean’][‘input’]> | (Optional) Whether to pin the metafield definition. | |
| useAsCollectionCondition? | InputMaybe<Scalars[‘Boolean’][‘input’]> | (Optional) Whether the metafield definition can be used as a collection condition. | |
| validations? | InputMaybe<Array<MetafieldDefinitionValidationInput>> | (Optional) A list of [validation options](https://shopify.dev/apps/metafields/definitions/validation) 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. |
|
| visibleToStorefrontApi? | InputMaybe<Scalars[‘Boolean’][‘input’]> | (Optional) Whether each of the metafields that belong to the metafield definition are visible from the Storefront API. |