metafieldDefinitionUpdate

mutation

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

Updates a metafield definition.

Arguments

Anchor to definitiondefinition • MetafieldDefinitionUpdateInput!required: The input fields for the metafield definition update.

Was this section helpful?

Anchor to MetafieldDefinitionUpdatePayload returnsMetafieldDefinitionUpdatePayload returns

Anchor to updatedDefinitionupdatedDefinition • MetafieldDefinition: The metafield definition that was updated.
Anchor to userErrorsuserErrors • [MetafieldDefinitionUpdateUserError!]!non-null: The list of errors that occurred from executing the mutation.
Anchor to validationJobvalidationJob • Job: The asynchronous job updating the metafield definition's validation_status.

Was this section helpful?

Update a metafield definition
Update a metafield definition with access controls
metafieldDefinitionUpdate reference

Examples

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

const response = await admin.graphql(

`#graphql

mutation UpdateMetafieldDefinition($definition: MetafieldDefinitionUpdateInput!) {

metafieldDefinitionUpdate(definition: $definition) {

updatedDefinition {

name

}

userErrors {

field

message

code

}

}`,

{

variables: {

"definition": {

"name": "Pizza size (inches)",

"namespace": "bakery",

"key": "pizza_size",

"ownerType": "PRODUCT"

}

);

const data = await response.json();

mutation UpdateMetafieldDefinition($definition: MetafieldDefinitionUpdateInput!) {
  metafieldDefinitionUpdate(definition: $definition) {
    updatedDefinition {
      id
      name
    }
    userErrors {
      field
      message
      code
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation UpdateMetafieldDefinition($definition: MetafieldDefinitionUpdateInput!) { metafieldDefinitionUpdate(definition: $definition) { updatedDefinition { id name } userErrors { field message code } } }",
 "variables": {
    "definition": {
      "name": "Pizza size (inches)",
      "namespace": "bakery",
      "key": "pizza_size",
      "ownerType": "PRODUCT"
    }
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation UpdateMetafieldDefinition($definition: MetafieldDefinitionUpdateInput!) {
    metafieldDefinitionUpdate(definition: $definition) {
      updatedDefinition {
        id
        name
      }
      userErrors {
        field
        message
        code
      }
    }
  }`,
  {
    variables: {
      "definition": {
        "name": "Pizza size (inches)",
        "namespace": "bakery",
        "key": "pizza_size",
        "ownerType": "PRODUCT"
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation UpdateMetafieldDefinition($definition: MetafieldDefinitionUpdateInput!) {
      metafieldDefinitionUpdate(definition: $definition) {
        updatedDefinition {
          id
          name
        }
        userErrors {
          field
          message
          code
        }
      }
    }`,
    "variables": {
      "definition": {
        "name": "Pizza size (inches)",
        "namespace": "bakery",
        "key": "pizza_size",
        "ownerType": "PRODUCT"
      }
    },
  },
});

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 UpdateMetafieldDefinition($definition: MetafieldDefinitionUpdateInput!) {
    metafieldDefinitionUpdate(definition: $definition) {
      updatedDefinition {
        id
        name
      }
      userErrors {
        field
        message
        code
      }
    }
  }
QUERY

variables = {
  "definition": {
    "name": "Pizza size (inches)",
    "namespace": "bakery",
    "key": "pizza_size",
    "ownerType": "PRODUCT"
  }
}

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

Input variables

JSON

{

"definition": {

"name": "Pizza size (inches)",

"namespace": "bakery",

"key": "pizza_size",

"ownerType": "PRODUCT"

}

Response

JSON

{

"metafieldDefinitionUpdate": {

"updatedDefinition": {

"id": "gid://shopify/MetafieldDefinition/1071456170",

"name": "Pizza size (inches)"

"userErrors": []

}