Skip to main content
Anchor to StandardMetafieldDefinitionEnablePayload

StandardMetafieldDefinitionEnablePayload

payload

Return type for standardMetafieldDefinitionEnable mutation.

•MetafieldDefinition

The metafield definition that was created.

•[StandardMetafieldDefinitionEnableUserError!]!
non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

•mutation

Activates the specified standard metafield definition from its template.

Refer to the list of standard metafield definition templates.

Arguments

•MetafieldOwnerType!
required

The resource type that the metafield definition is scoped to.

•ID

The ID of the standard metafield definition template to enable.

•String

The namespace of the standard metafield to enable. Used in combination with key.

•String

The key of the standard metafield to enable. Used in combination with namespace.

•Boolean
Default:null

Whether to pin the metafield definition.

Anchor to visibleToStorefrontApivisibleToStorefrontApi
•Boolean
DeprecatedDefault:null
Anchor to useAsCollectionConditionuseAsCollectionCondition
•Boolean
DeprecatedDefault:null
•MetafieldCapabilityCreateInput

The capabilities of the metafield definition.

•StandardMetafieldDefinitionAccessInput

The access settings that apply to each of the metafields that belong to the metafield definition.



Was this section helpful?