Metafield
The input fields required to update a metafield definition.
Anchor to FieldsFields
- access (MetafieldAccessUpdateInput)
- capabilities (MetafieldCapabilityUpdateInput)
- constraintsUpdates (MetafieldDefinitionConstraintsUpdatesInput)
- description (String)
- key (String!)
- name (String)
- namespace (String)
- ownerType (MetafieldOwnerType!)
- pin (Boolean)
- validations ([MetafieldDefinitionValidationInput!])
- useAsCollectionCondition (Boolean): deprecated
- Anchor to accessaccess•Metafield
Access Update Input The access settings that apply to each of the metafields that belong to the metafield definition.
Show input fields
- Anchor to capabilitiescapabilities•Metafield
Capability Update Input The capabilities of the metafield definition.
Show input fields
- Anchor to constraintsUpdatesconstraints•Metafield
Updates Definition Constraints Updates Input The constraints that determine what resources a metafield definition applies to.
Show input fields
- Anchor to descriptiondescription•String
The description for the metafield definition.
- •String!non-null
The unique identifier for the metafield definition within its namespace. Used to help identify the metafield definition, but can't be updated itself.
- Anchor to namename•String
The human-readable name for the metafield definition.
- Anchor to namespacenamespace•String
The container for a group of metafields that the metafield definition is associated with. Used to help identify the metafield definition, but can't be updated itself. If omitted, the app-reserved namespace will be used.
- Anchor to ownerTypeowner•Metafield
Type Owner Type! non-null The resource type that the metafield definition is attached to. Used to help identify the metafield definition, but can't be updated itself.
Show enum values
- •Boolean
Whether to pin the metafield definition.
- Anchor to validationsvalidations•[Metafield
Definition Validation Input!] 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.Show input fields
- Anchor to useAsCollectionConditionuse•Boolean
As Collection Condition DeprecatedDefault:false