privateMetafieldDelete mutation

Deletes a private metafield.

On this page

• Interactive example
• Arguments
• PrivateMetafieldDeleteInput fields
• Return fields

Interactive example

This is an example mutation query.

<font style="color:#1F61A0;">deletedPrivateMetafieldId</font>
<font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">field</font>
  <font style="color:#1F61A0;">message</font>
<font style="color:#555555;">}</font>

<font style="color:#8B2BB9;">"namespace"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font><font style="color:#555555;">,</font>
<font style="color:#8B2BB9;">"key"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font>

Arguments

PrivateMetafieldDeleteInput fields

• key ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)) REQUIRED
  The key for the private metafield.
• namespace ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)) REQUIRED
  The namespace for the private metafield.
• owner ([ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
  The ID of the owning resource.

Return fields

• deletedPrivateMetafieldId ([ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
  The ID of private metafield that was deleted.
• userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
  List of errors that occurred executing the mutation.