Skip to main content
Anchor to MetafieldDefinitionIdentifier

MetafieldDefinitionIdentifier

object

Identifies a metafield definition by its owner type, namespace, and key.

Anchor to FieldsFields

Anchor to keykey
•String!
non-null

The unique identifier for the metafield definition within its namespace.

Anchor to namespacenamespace
•String!
non-null

The container for a group of metafields that the metafield definition is associated with.

Anchor to ownerTypeownerType
•MetafieldOwnerType!
non-null

The resource type that the metafield definition is attached to.

Was this section helpful?

Anchor to MutationsMutations

Anchor to metafieldDefinitionDeletemetafieldDefinitionDelete
•mutation

Deletes a MetafieldDefinition. You can identify the definition by providing either its owner type, namespace, and key, or its global ID.

When you set deleteAllAssociatedMetafields to true, the mutation asynchronously deletes all Metafield objects that use this definition. This option must be true when deleting definitions under the $app namespace.

Learn more about deleting metafield definitions.

Arguments

Anchor to idid
•ID

The id of the metafield definition to delete. Using identifier is preferred.

Anchor to identifieridentifier
•MetafieldDefinitionIdentifierInput

The identifier of the metafield definition to delete.

Anchor to deleteAllAssociatedMetafieldsdeleteAllAssociatedMetafields
•Boolean
Default:false

Whether to delete all associated metafields.

Was this section helpful?