Skip to main content
Anchor to MetafieldDefinitionDeletePayload

MetafieldDefinitionDeletePayload

payload

Return type for metafieldDefinitionDelete mutation.

Anchor to FieldsFields

Anchor to deletedDefinitiondeletedDefinition
•MetafieldDefinitionIdentifier

The metafield definition that was deleted.

Anchor to deletedDefinitionIddeletedDefinitionId
•ID

The ID of the deleted metafield definition.

Anchor to userErrorsuserErrors
•[MetafieldDefinitionDeleteUserError!]!
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

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?