---
title: metafieldDefinitionDelete - GraphQL Admin
description: |-
  Delete a metafield definition.
  Optionally deletes all associated metafields asynchronously when specified.
api_version: 2024-10
api_name: admin
type: mutation
api_type: graphql
source_url:
  html: >-
    https://shopify.dev/docs/api/admin-graphql/2024-10/mutations/metafieldDefinitionDelete
  md: >-
    https://shopify.dev/docs/api/admin-graphql/2024-10/mutations/metafieldDefinitionDelete.txt
---

# metafield​Definition​Delete

mutation

Requires API client to have access to the resource type associated with the metafield definition.

Delete a metafield definition. Optionally deletes all associated metafields asynchronously when specified.

## Arguments

* delete​All​Associated​Metafields

  [Boolean](https://shopify.dev/docs/api/admin-graphql/2024-10/scalars/Boolean)

  Default:false

  Whether to delete all associated metafields.

* id

  [ID!](https://shopify.dev/docs/api/admin-graphql/2024-10/scalars/ID)

  required

  The id of the metafield definition to delete.

***

## Metafield​Definition​Delete​Payload returns

* deleted​Definition​Id

  [ID](https://shopify.dev/docs/api/admin-graphql/2024-10/scalars/ID)

  The ID of the deleted metafield definition.

* user​Errors

  [\[Metafield​Definition​Delete​User​Error!\]!](https://shopify.dev/docs/api/admin-graphql/2024-10/objects/MetafieldDefinitionDeleteUserError)

  non-null

  The list of errors that occurred from executing the mutation.

***

## Examples

* ### Delete a metafield definition

  #### Description

  To delete a metafield definition, use the \`metafieldDefinitionDelete\` mutation. The following example shows how to delete the metafield definition for \`bakery.ingredients\`, and also deletes all metafields that use the definition.

  #### Query

  ```graphql
  mutation DeleteMetafieldDefinition($id: ID!, $deleteAllAssociatedMetafields: Boolean!) {
    metafieldDefinitionDelete(id: $id, deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields) {
      deletedDefinitionId
      userErrors {
        field
        message
        code
      }
    }
  }
  ```

  #### Variables

  ```json
  {
    "id": "gid://shopify/MetafieldDefinition/1071456130",
    "deleteAllAssociatedMetafields": true
  }
  ```

  #### cURL

  ```bash
  curl -X POST \
  https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
  -H 'Content-Type: application/json' \
  -H 'X-Shopify-Access-Token: {access_token}' \
  -d '{
  "query": "mutation DeleteMetafieldDefinition($id: ID!, $deleteAllAssociatedMetafields: Boolean!) { metafieldDefinitionDelete(id: $id, deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields) { deletedDefinitionId userErrors { field message code } } }",
   "variables": {
      "id": "gid://shopify/MetafieldDefinition/1071456130",
      "deleteAllAssociatedMetafields": true
    }
  }'
  ```

  #### Remix

  ```javascript
  const { admin } = await authenticate.admin(request);

  const response = await admin.graphql(
    `#graphql
    mutation DeleteMetafieldDefinition($id: ID!, $deleteAllAssociatedMetafields: Boolean!) {
      metafieldDefinitionDelete(id: $id, deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields) {
        deletedDefinitionId
        userErrors {
          field
          message
          code
        }
      }
    }`,
    {
      variables: {
          "id": "gid://shopify/MetafieldDefinition/1071456130",
          "deleteAllAssociatedMetafields": true
      },
    },
  );

  const data = await response.json();
  ```

  #### Ruby

  ```ruby
  session = ShopifyAPI::Auth::Session.new(
    shop: "your-development-store.myshopify.com",
    access_token: access_token
  )
  client = ShopifyAPI::Clients::Graphql::Admin.new(
    session: session
  )

  query = <<~QUERY
    mutation DeleteMetafieldDefinition($id: ID!, $deleteAllAssociatedMetafields: Boolean!) {
      metafieldDefinitionDelete(id: $id, deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields) {
        deletedDefinitionId
        userErrors {
          field
          message
          code
        }
      }
    }
  QUERY

  variables = {
    "id": "gid://shopify/MetafieldDefinition/1071456130",
    "deleteAllAssociatedMetafields": true
  }

  response = client.query(query: query, variables: variables)
  ```

  #### Node.js

  ```javascript
  const client = new shopify.clients.Graphql({session});
  const data = await client.query({
    data: {
      "query": `mutation DeleteMetafieldDefinition($id: ID!, $deleteAllAssociatedMetafields: Boolean!) {
        metafieldDefinitionDelete(id: $id, deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields) {
          deletedDefinitionId
          userErrors {
            field
            message
            code
          }
        }
      }`,
      "variables": {
          "id": "gid://shopify/MetafieldDefinition/1071456130",
          "deleteAllAssociatedMetafields": true
      },
    },
  });
  ```

  #### Response

  ```json
  {
    "metafieldDefinitionDelete": {
      "deletedDefinitionId": "gid://shopify/MetafieldDefinition/1071456130",
      "userErrors": []
    }
  }
  ```

* ### metafieldDefinitionDelete reference

[Open in GraphiQL](http://localhost:3457/graphiql?query=mutation%20DeleteMetafieldDefinition\(%24id%3A%20ID!%2C%20%24deleteAllAssociatedMetafields%3A%20Boolean!\)%20%7B%0A%20%20metafieldDefinitionDelete\(id%3A%20%24id%2C%20deleteAllAssociatedMetafields%3A%20%24deleteAllAssociatedMetafields\)%20%7B%0A%20%20%20%20deletedDefinitionId%0A%20%20%20%20userErrors%20%7B%0A%20%20%20%20%20%20field%0A%20%20%20%20%20%20message%0A%20%20%20%20%20%20code%0A%20%20%20%20%7D%0A%20%20%7D%0A%7D\&variables=%7B%0A%20%20%22id%22%3A%20%22gid%3A%2F%2Fshopify%2FMetafieldDefinition%2F1071456130%22%2C%0A%20%20%22deleteAllAssociatedMetafields%22%3A%20true%0A%7D)

```javascript
const { admin } = await authenticate.admin(request);


const response = await admin.graphql(
  `#graphql
  mutation DeleteMetafieldDefinition($id: ID!, $deleteAllAssociatedMetafields: Boolean!) {
    metafieldDefinitionDelete(id: $id, deleteAllAssociatedMetafields: $deleteAllAssociatedMetafields) {
      deletedDefinitionId
      userErrors {
        field
        message
        code
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/MetafieldDefinition/1071456130",
        "deleteAllAssociatedMetafields": true
    },
  },
);


const data = await response.json();
```

## Input variables

JSON

```json
{
  "id": "gid://shopify/MetafieldDefinition/1071456130",
  "deleteAllAssociatedMetafields": true
}
```

## Response

JSON

```json
{
  "metafieldDefinitionDelete": {
    "deletedDefinitionId": "gid://shopify/MetafieldDefinition/1071456130",
    "userErrors": []
  }
}
```