privateMetafieldUpsert mutation

Creates or update a private metafield.

On this page

Interactive example

This is an example mutation query.

mutation privateMetafieldUpsert($input: PrivateMetafieldInput!) { privateMetafieldUpsert(input: $input) { 
  1. <font style="color:#1F61A0;">privateMetafield</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">field</font>
  11.   <font style="color:#1F61A0;">message</font>
  13. <font style="color:#555555;">}</font>
} } { “input”: { 
<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><font style="color:#555555;">,</font>

<font style="color:#8B2BB9;">"valueInput"</font><font style="color:#555555;">:</font> <font style="color:#555555;">{</font>

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

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

<font style="color:#555555;">}</font>
} }

Arguments

Argument Description
input
(
[PrivateMetafieldInput!](https://shopify.dev/docs/admin-api/graphql/reference/metafields/privatemetafieldinput)

) REQUIRED		 Specifies the input fields for the private metafield.

PrivateMetafieldInput 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 owning resource.
  • valueInput ([PrivateMetafieldValueInput!](https://shopify.dev/docs/admin-api/graphql/reference/metafields/privatemetafieldvalueinput)) REQUIRED
    The value and value type of the metafield, wrapped in a ValueInput object.

Return fields

  • privateMetafield ([PrivateMetafield](https://shopify.dev/docs/admin-api/graphql/reference/metafields/privatemetafield))
    The private metafield that was created or updated.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.