Anchor to section titled 'undefined'private
private
mutation
deprecated
Unstable
Deletes a private metafield. Private metafields are automatically deleted when the app that created them is uninstalled. Metafields created using a reserved namespace are private by default. See our guide for migrating private metafields.
Anchor to section titled 'Arguments'
Arguments
The input fields for the private metafield to delete.
Was this section helpful?
Anchor to section titled 'PrivateMetafieldDeletePayload returns'
PrivateMetafieldDeletePayload returns
- Anchor to PrivateMetafieldDeletePayload.deletedPrivateMetafieldIddeleted
Private Metafield Id The ID of private metafield that was deleted.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: privateMetafieldDelete
Query Reference for MUTATION: privateMetafieldDelete
"mutation privateMetafieldDelete($input: PrivateMetafieldDeleteInput!) {\n privateMetafieldDelete(input: $input) {\n deletedPrivateMetafieldId\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: privateMetafieldDelete
"{\n \"input\": {\n \"key\": \"<your-key>\",\n \"namespace\": \"<your-namespace>\",\n \"owner\": \"gid://shopify/<objectName>/10079785100\"\n }\n}"Schema Reference for MUTATION: privateMetafieldDelete
"input PrivateMetafieldDeleteInput {\n key: String!\n namespace: String!\n owner: ID\n}\n"Display Examples for MUTATION: privateMetafieldDelete
[
{
"example": {
"type_name": "privatemetafielddelete",
"title": "Delete a private metafield owned by the Product resource",
"description": "Use the `privateMetafieldDelete` mutation to delete a private metafield.\nSpecify the private metafield that you want to delete by providing its namespace, key, and the ID of the owning resource.\n",
"query_string": "mutation privateMetafieldDelete($input: PrivateMetafieldDeleteInput!) {\n privateMetafieldDelete(input: $input) {\n deletedPrivateMetafieldId\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"input": {
"owner": "gid://shopify/Product/20995642",
"namespace": "wholesale",
"key": "price"
}
},
"response": {
"data": {
"privateMetafieldDelete": {
"deletedPrivateMetafieldId": "gid://shopify/PrivateMetafield/1060470839",
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/content/metafields/test/unit/graph_api/admin/mutations/private_metafield_delete_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation privateMetafieldDelete($input: PrivateMetafieldDeleteInput!) { privateMetafieldDelete(input: $input) { deletedPrivateMetafieldId userErrors { field message } } }\",\n \"variables\": {\n \"input\": {\n \"owner\": \"gid://shopify/Product/20995642\",\n \"namespace\": \"wholesale\",\n \"key\": \"price\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation privateMetafieldDelete($input: PrivateMetafieldDeleteInput!) {\n privateMetafieldDelete(input: $input) {\n deletedPrivateMetafieldId\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"owner\": \"gid://shopify/Product/20995642\",\n \"namespace\": \"wholesale\",\n \"key\": \"price\"\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 privateMetafieldDelete($input: PrivateMetafieldDeleteInput!) {\n privateMetafieldDelete(input: $input) {\n deletedPrivateMetafieldId\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"owner\": \"gid://shopify/Product/20995642\",\n \"namespace\": \"wholesale\",\n \"key\": \"price\"\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 privateMetafieldDelete($input: PrivateMetafieldDeleteInput!) {\n privateMetafieldDelete(input: $input) {\n deletedPrivateMetafieldId\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"owner\": \"gid://shopify/Product/20995642\",\n \"namespace\": \"wholesale\",\n \"key\": \"price\"\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 privateMetafieldDelete($input: PrivateMetafieldDeleteInput!) {\n privateMetafieldDelete(input: $input) {\n deletedPrivateMetafieldId\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"owner\" => \"gid://shopify/Product/20995642\",\n \"namespace\" => \"wholesale\",\n \"key\" => \"price\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "The input fields for the private metafield to delete.",
"type": {
"kind": "INPUT_OBJECT",
"name": "PrivateMetafieldDeleteInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "PrivateMetafieldDeleteInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"owner\":\"gid://shopify/Product/20995642\",\"namespace\":\"wholesale\",\"key\":\"price\"}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "privatemetafielddelete",
"title": "Delete a private metafield owned by the Shop resource",
"description": "Use the `privateMetafieldDelete` mutation to delete a private metafield.\nSpecify the private metafield that you want to delete by providing its namespace, key, and the ID of the owning resource.\nIn this example, the private metafield belongs to the `Shop` resource, so the owner field can be omitted.\n",
"query_string": "mutation privateMetafieldDelete($input: PrivateMetafieldDeleteInput!) {\n privateMetafieldDelete(input: $input) {\n deletedPrivateMetafieldId\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"input": {
"namespace": "private_keys",
"key": "fantastic_app"
}
},
"response": {
"data": {
"privateMetafieldDelete": {
"deletedPrivateMetafieldId": "gid://shopify/PrivateMetafield/1060470838",
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/content/metafields/test/unit/graph_api/admin/mutations/private_metafield_delete_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation privateMetafieldDelete($input: PrivateMetafieldDeleteInput!) { privateMetafieldDelete(input: $input) { deletedPrivateMetafieldId userErrors { field message } } }\",\n \"variables\": {\n \"input\": {\n \"namespace\": \"private_keys\",\n \"key\": \"fantastic_app\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation privateMetafieldDelete($input: PrivateMetafieldDeleteInput!) {\n privateMetafieldDelete(input: $input) {\n deletedPrivateMetafieldId\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"namespace\": \"private_keys\",\n \"key\": \"fantastic_app\"\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 privateMetafieldDelete($input: PrivateMetafieldDeleteInput!) {\n privateMetafieldDelete(input: $input) {\n deletedPrivateMetafieldId\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"namespace\": \"private_keys\",\n \"key\": \"fantastic_app\"\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 privateMetafieldDelete($input: PrivateMetafieldDeleteInput!) {\n privateMetafieldDelete(input: $input) {\n deletedPrivateMetafieldId\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"namespace\": \"private_keys\",\n \"key\": \"fantastic_app\"\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 privateMetafieldDelete($input: PrivateMetafieldDeleteInput!) {\n privateMetafieldDelete(input: $input) {\n deletedPrivateMetafieldId\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"namespace\" => \"private_keys\",\n \"key\" => \"fantastic_app\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "The input fields for the private metafield to delete.",
"type": {
"kind": "INPUT_OBJECT",
"name": "PrivateMetafieldDeleteInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "PrivateMetafieldDeleteInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"namespace\":\"private_keys\",\"key\":\"fantastic_app\"}",
"typeKind": "MUTATION"
}
]
}
]