Skip to main content
Anchor to StandardMetafieldDefinitionEnablePayload

StandardMetafieldDefinitionEnablePayload

payload

Return type for standardMetafieldDefinitionEnable mutation.

•MetafieldDefinition

The metafield definition that was created.

Show fields
•[StandardMetafieldDefinitionEnableUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Show fields

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.

Show payload

Arguments

•StandardMetafieldDefinitionAccessInput

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

Show input fields
•MetafieldCapabilityCreateInput

The capabilities of the metafield definition.

Show input fields
•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.

•String

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

•MetafieldOwnerType!
required

The resource type that the metafield definition is scoped to.

Show enum values
•Boolean
Default:null

Whether to pin the metafield definition.

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


Was this section helpful?