The input fields required to update a metafield definition.
Access Scopes
Fields
access:
MetafieldAccessUpdateInput -
The access settings that apply to each of the metafields that belong to the metafield definition.
capabilities:
MetafieldCapabilityUpdateInput -
The capabilities of the metafield definition.
description:
String -
The description for the metafield definition.
key:
String! -
The unique identifier for the metafield definition within its namespace. Used to help identify the metafield
definition, but can't be updated itself.
name:
String -
The human-readable name for the metafield definition.
namespace:
String -
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! -
The resource type that the metafield definition is attached to. Used to help identify the metafield definition,
but can't be updated itself.
pin:
Boolean -
Whether to pin the metafield definition.
useAsCollectionCondition:
Boolean -
Whether the metafield definition can be used as a collection condition.
validations:
MetafieldDefinitionValidationInput -
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:
Boolean -
Whether each of the metafields that belong to the metafield definition are visible from the Storefront API.