# privateMetafieldDelete - admin-graphql - MUTATION Version: 2024-10 ## Description Deletes a private metafield. Private metafields are automatically deleted when the app that created them is uninstalled. ### Access Scopes ## Arguments * [input](/docs/api/admin-graphql/2024-10/input-objects/PrivateMetafieldDeleteInput): PrivateMetafieldDeleteInput! - The input fields for the private metafield to delete. ## Returns * [deletedPrivateMetafieldId](/docs/api/admin-graphql/2024-10/scalars/ID): ID The ID of private metafield that was deleted. * [userErrors](/docs/api/admin-graphql/2024-10/objects/UserError): UserError! The list of errors that occurred from executing the mutation. ## Examples ### Delete a private metafield owned by the Product resource Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/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" 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" 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" 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" Graphql query: "mutation privateMetafieldDelete($input: PrivateMetafieldDeleteInput!) {\n privateMetafieldDelete(input: $input) {\n deletedPrivateMetafieldId\n userErrors {\n field\n message\n }\n }\n}" #### Graphql Input { "input": { "owner": "gid://shopify/Product/20995642", "namespace": "wholesale", "key": "price" } } #### Graphql Response { "data": { "privateMetafieldDelete": { "deletedPrivateMetafieldId": "gid://shopify/PrivateMetafield/1060470839", "userErrors": [] } } } ### Delete a private metafield owned by the Shop resource Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/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" 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" 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" 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" Graphql query: "mutation privateMetafieldDelete($input: PrivateMetafieldDeleteInput!) {\n privateMetafieldDelete(input: $input) {\n deletedPrivateMetafieldId\n userErrors {\n field\n message\n }\n }\n}" #### Graphql Input { "input": { "namespace": "private_keys", "key": "fantastic_app" } } #### Graphql Response { "data": { "privateMetafieldDelete": { "deletedPrivateMetafieldId": "gid://shopify/PrivateMetafield/1060470838", "userErrors": [] } } }