metafieldDefinitionDelete

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

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the metafieldDefinitionDelete action (under Metafield).
Fill in the fields below, then reference the result from later steps as {{metafielddefinitiondelete.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation MetafieldDefinitionDelete($id: ID, $identifier: MetafieldDefinitionIdentifierInput, $deleteAllAssociatedMetafields: Boolean) {
  metafieldDefinitionDelete(
    id: $id
    identifier: $identifier
    deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields
  ) {
    deletedDefinition {
      key
      namespace
      ownerType
    }
    deletedDefinitionId
    userErrors {
      code
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

idstring

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

identifierobject

The identifier of the metafield definition to delete.

ownerTypestringrequired

One ofAPI_PERMISSIONCOMPANYCOMPANY_LOCATIONPAYMENT_CUSTOMIZATIONVALIDATIONCUSTOMERDELIVERY_CUSTOMIZATIONDRAFTORDERGIFT_CARD_TRANSACTIONTRANSFERMARKETCARTTRANSFORMCOLLECTIONMEDIA_IMAGEPRODUCTPRODUCTVARIANTSELLING_PLANARTICLEBLOGPAGEFULFILLMENT_CONSTRAINT_RULEORDER_ROUTING_LOCATION_RULEDISCOUNTORDERLOCATIONSHOP

namespacestring

keystringrequired

deleteAllAssociatedMetafieldsboolean

Whether to delete all associated metafields.

json

{
  "id": "string",
  "identifier": {
    "ownerType": "API_PERMISSION",
    "key": "string",
    "namespace": "string"
  },
  "deleteAllAssociatedMetafields": false
}

Response

Read the result with {{metafielddefinitiondelete.response.data.data.metafieldDefinitionDelete}}. If the API returns errors, the step fails and they are at {{metafielddefinitiondelete.response.data.errors}}.

deletedDefinitionobject

keystring

namespacestring

ownerTypestring

deletedDefinitionIdstring

userErrorsarray<object>

codeobject

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?