The input fields for creating a metaobject field definition.
Access Scopes
Fields
description:
String -
An administrative description of the field.
key:
String! -
The key of the new field definition. This can't be changed.
Must be 3-64 characters long and only contain alphanumeric, hyphen, and underscore characters.
name:
String -
A human-readable name for the field. This can be changed at any time.
required:
Boolean -
Whether metaobjects require a saved value for the field.
type:
String! -
The metafield type applied to values of the field.
validations:
MetafieldDefinitionValidationInput -
Custom validations that apply to values assigned to the field.
visibleToStorefrontApi:
Boolean -
Whether the field is visible to the storefront API.
Defaults to the visibility of the parent metaobject definition.