Anchor to standardMetafieldDefinitionEnablestandard
mutationstandard Metafield Definition Enable
Requires API client to have access to the resource type associated with the metafield definition owner type.
Activates the specified standard metafield definition from its template.
Refer to the list of standard metafield definition templates.
Anchor to Arguments
Arguments
- •ID
The ID of the standard metafield definition template to enable.
- •String
The key of the standard metafield to enable. Used in combination with
namespace
.- Anchor to namespacenamespace•String
The namespace of the standard metafield to enable. Used in combination with
key
.- Anchor to ownerTypeowner•Metafield
Type Owner Type! required The resource type that the metafield definition is scoped to.
- •Boolean!requiredDefault:false
Whether to pin the metafield definition.
- Anchor to visibleToStorefrontApivisible•Boolean
To Storefront Api Default:null Whether metafields for the definition are visible using the Storefront API.
- Anchor to useAsCollectionConditionuse•Boolean
As Collection Condition DeprecatedDefault:false
Was this section helpful?
Anchor to StandardMetafieldDefinitionEnablePayload returnsStandard Metafield Definition Enable Payload returns
- Anchor to createdDefinitioncreated•Metafield
Definition Definition The metafield definition that was created.
- Anchor to userErrorsuser•[Standard
Errors Metafield Definition Enable User Error!]! non-null The list of errors that occurred from executing the mutation.
Was this section helpful?