Anchor to section titled 'undefined'metafield
metafield
mutation
2024-04
Requires API client to have access to the namespace and the resource type associated with the metafield definition.
Updates a metafield definition.
Anchor to section titled 'Arguments'
Arguments
The input fields for the metafield definition update.
Was this section helpful?
Anchor to section titled 'MetafieldDefinitionUpdatePayload returns'
MetafieldDefinitionUpdatePayload returns
The metafield definition that was updated.
The list of errors that occurred from executing the mutation.
The asynchronous job updating the metafield definition's validation_status.
Was this section helpful?
Code examples for MUTATION: metafieldDefinitionUpdate
Query Reference for MUTATION: metafieldDefinitionUpdate
"mutation metafieldDefinitionUpdate($definition: MetafieldDefinitionUpdateInput!) {\n metafieldDefinitionUpdate(definition: $definition) {\n updatedDefinition {\n # MetafieldDefinition fields\n }\n userErrors {\n field\n message\n }\n validationJob {\n # Job fields\n }\n }\n}"Input Reference for MUTATION: metafieldDefinitionUpdate
"{\n \"definition\": {\n \"access\": {\n \"admin\": \"MERCHANT_READ\",\n \"grants\": [\n {\n \"create\": {\n \"access\": \"READ\",\n \"grantee\": \"<your-grantee>\"\n },\n \"delete\": {\n \"grantee\": \"<your-grantee>\"\n },\n \"update\": {\n \"access\": \"READ\",\n \"grantee\": \"<your-grantee>\"\n }\n }\n ],\n \"storefront\": \"NONE\"\n },\n \"description\": \"<your-description>\",\n \"key\": \"<your-key>\",\n \"name\": \"<your-name>\",\n \"namespace\": \"<your-namespace>\",\n \"ownerType\": \"API_PERMISSION\",\n \"pin\": true,\n \"validations\": [\n {\n \"name\": \"<your-name>\",\n \"value\": \"<your-value>\"\n }\n ]\n }\n}"Schema Reference for MUTATION: metafieldDefinitionUpdate
"input MetafieldDefinitionUpdateInput {\n access: MetafieldAccessUpdateInput\n description: String\n key: String!\n name: String\n namespace: String\n ownerType: MetafieldOwnerType!\n pin: Boolean\n useAsCollectionCondition: Boolean\n validations: [MetafieldDefinitionValidationInput!]\n visibleToStorefrontApi: Boolean\n}\n\ninput MetafieldAccessUpdateInput {\n admin: MetafieldAdminAccess!\n grants: [MetafieldAccessGrantOperationInput!]\n storefront: MetafieldStorefrontAccess\n}\n\ninput MetafieldDefinitionValidationInput {\n name: String!\n value: String!\n}\n"Display Examples for MUTATION: metafieldDefinitionUpdate
[
{
"example": {
"type_name": "metafielddefinitionupdate",
"title": "Update a metafield definition",
"description": "To update a metafield definition, use the `metafieldDefinitionUpdate` mutation.\nThe following example shows how to change a metafield definition's name from `Pizza size` to `Pizza\nsize (inches)`.\n",
"query_string": "mutation UpdateMetafieldDefinition($definition: MetafieldDefinitionUpdateInput!) {\n metafieldDefinitionUpdate(definition: $definition) {\n updatedDefinition {\n id\n name\n }\n userErrors {\n field\n message\n code\n }\n }\n}",
"variables": {
"definition": {
"name": "Pizza size (inches)",
"namespace": "bakery",
"key": "pizza_size",
"ownerType": "PRODUCT"
}
},
"response": {
"data": {
"metafieldDefinitionUpdate": {
"updatedDefinition": {
"id": "gid://shopify/MetafieldDefinition/1071456170",
"name": "Pizza size (inches)"
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/content/metafields/test/unit/graph_api/admin/mutations/metafield_definition_update_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation UpdateMetafieldDefinition($definition: MetafieldDefinitionUpdateInput!) { metafieldDefinitionUpdate(definition: $definition) { updatedDefinition { id name } userErrors { field message code } } }\",\n \"variables\": {\n \"definition\": {\n \"name\": \"Pizza size (inches)\",\n \"namespace\": \"bakery\",\n \"key\": \"pizza_size\",\n \"ownerType\": \"PRODUCT\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation UpdateMetafieldDefinition($definition: MetafieldDefinitionUpdateInput!) {\n metafieldDefinitionUpdate(definition: $definition) {\n updatedDefinition {\n id\n name\n }\n userErrors {\n field\n message\n code\n }\n }\n }`,\n {\n variables: {\n \"definition\": {\n \"name\": \"Pizza size (inches)\",\n \"namespace\": \"bakery\",\n \"key\": \"pizza_size\",\n \"ownerType\": \"PRODUCT\"\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation UpdateMetafieldDefinition($definition: MetafieldDefinitionUpdateInput!) {\n metafieldDefinitionUpdate(definition: $definition) {\n updatedDefinition {\n id\n name\n }\n userErrors {\n field\n message\n code\n }\n }\n }\nQUERY\n\nvariables = {\n \"definition\": {\n \"name\": \"Pizza size (inches)\",\n \"namespace\": \"bakery\",\n \"key\": \"pizza_size\",\n \"ownerType\": \"PRODUCT\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation UpdateMetafieldDefinition($definition: MetafieldDefinitionUpdateInput!) {\n metafieldDefinitionUpdate(definition: $definition) {\n updatedDefinition {\n id\n name\n }\n userErrors {\n field\n message\n code\n }\n }\n }`,\n \"variables\": {\n \"definition\": {\n \"name\": \"Pizza size (inches)\",\n \"namespace\": \"bakery\",\n \"key\": \"pizza_size\",\n \"ownerType\": \"PRODUCT\"\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation UpdateMetafieldDefinition($definition: MetafieldDefinitionUpdateInput!) {\n metafieldDefinitionUpdate(definition: $definition) {\n updatedDefinition {\n id\n name\n }\n userErrors {\n field\n message\n code\n }\n }\n }\nQUERY;\n\n$variables = [\n \"definition\" => [\n \"name\" => \"Pizza size (inches)\",\n \"namespace\" => \"bakery\",\n \"key\" => \"pizza_size\",\n \"ownerType\" => \"PRODUCT\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "definition",
"description": "The input fields for the metafield definition update.",
"type": {
"kind": "INPUT_OBJECT",
"name": "MetafieldDefinitionUpdateInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "MetafieldDefinitionUpdateInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "definition",
"argValue": " {\"name\":\"Pizza size (inches)\",\"namespace\":\"bakery\",\"key\":\"pizza_size\",\"ownerType\":\"PRODUCT\"}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "metafielddefinitionupdate",
"title": "Update a metafield definition with access controls",
"description": "To change the access settings on an existing definition, use the `access` property in your\n`metafieldDefinitionUpdate` mutation. You can set the default admin access setting and also specify\nadditional grants to create, update or delete.\n",
"query_string": "mutation UpdateMetafieldDefinition($definition: MetafieldDefinitionUpdateInput!) {\n metafieldDefinitionUpdate(definition: $definition) {\n updatedDefinition {\n id\n name\n access {\n admin\n }\n }\n userErrors {\n field\n message\n code\n }\n }\n}",
"variables": {
"definition": {
"name": "Pizza size (inches)",
"namespace": "$app:bakery",
"key": "pizza_size",
"ownerType": "PRODUCT",
"access": {
"admin": "PRIVATE"
}
}
},
"response": {
"data": {
"metafieldDefinitionUpdate": {
"updatedDefinition": {
"id": "gid://shopify/MetafieldDefinition/1071456171",
"name": "Pizza size (inches)",
"access": {
"admin": "PRIVATE"
}
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/content/metafields/test/unit/graph_api/admin/mutations/metafield_definition_update_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation UpdateMetafieldDefinition($definition: MetafieldDefinitionUpdateInput!) { metafieldDefinitionUpdate(definition: $definition) { updatedDefinition { id name access { admin } } userErrors { field message code } } }\",\n \"variables\": {\n \"definition\": {\n \"name\": \"Pizza size (inches)\",\n \"namespace\": \"$app:bakery\",\n \"key\": \"pizza_size\",\n \"ownerType\": \"PRODUCT\",\n \"access\": {\n \"admin\": \"PRIVATE\"\n }\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation UpdateMetafieldDefinition($definition: MetafieldDefinitionUpdateInput!) {\n metafieldDefinitionUpdate(definition: $definition) {\n updatedDefinition {\n id\n name\n access {\n admin\n }\n }\n userErrors {\n field\n message\n code\n }\n }\n }`,\n {\n variables: {\n \"definition\": {\n \"name\": \"Pizza size (inches)\",\n \"namespace\": \"$app:bakery\",\n \"key\": \"pizza_size\",\n \"ownerType\": \"PRODUCT\",\n \"access\": {\n \"admin\": \"PRIVATE\"\n }\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation UpdateMetafieldDefinition($definition: MetafieldDefinitionUpdateInput!) {\n metafieldDefinitionUpdate(definition: $definition) {\n updatedDefinition {\n id\n name\n access {\n admin\n }\n }\n userErrors {\n field\n message\n code\n }\n }\n }\nQUERY\n\nvariables = {\n \"definition\": {\n \"name\": \"Pizza size (inches)\",\n \"namespace\": \"$app:bakery\",\n \"key\": \"pizza_size\",\n \"ownerType\": \"PRODUCT\",\n \"access\": {\n \"admin\": \"PRIVATE\"\n }\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation UpdateMetafieldDefinition($definition: MetafieldDefinitionUpdateInput!) {\n metafieldDefinitionUpdate(definition: $definition) {\n updatedDefinition {\n id\n name\n access {\n admin\n }\n }\n userErrors {\n field\n message\n code\n }\n }\n }`,\n \"variables\": {\n \"definition\": {\n \"name\": \"Pizza size (inches)\",\n \"namespace\": \"$app:bakery\",\n \"key\": \"pizza_size\",\n \"ownerType\": \"PRODUCT\",\n \"access\": {\n \"admin\": \"PRIVATE\"\n }\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation UpdateMetafieldDefinition($definition: MetafieldDefinitionUpdateInput!) {\n metafieldDefinitionUpdate(definition: $definition) {\n updatedDefinition {\n id\n name\n access {\n admin\n }\n }\n userErrors {\n field\n message\n code\n }\n }\n }\nQUERY;\n\n$variables = [\n \"definition\" => [\n \"name\" => \"Pizza size (inches)\",\n \"namespace\" => \"$app:bakery\",\n \"key\" => \"pizza_size\",\n \"ownerType\" => \"PRODUCT\",\n \"access\" => [\n \"admin\" => \"PRIVATE\",\n ],\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "definition",
"description": "The input fields for the metafield definition update.",
"type": {
"kind": "INPUT_OBJECT",
"name": "MetafieldDefinitionUpdateInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "MetafieldDefinitionUpdateInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "definition",
"argValue": " {\"name\":\"Pizza size (inches)\",\"namespace\":\"$app:bakery\",\"key\":\"pizza_size\",\"ownerType\":\"PRODUCT\",\"access\":{\"admin\":\"PRIVATE\"}}",
"typeKind": "MUTATION"
}
]
}
]