Choose a version:

metafieldsSet

mutation

Set or Update a Metafield on a resource.

Anchor to Arguments

Arguments

Anchor to metafieldsmetafields

•[MetafieldSetInput!]!

required

Was this section helpful?

Anchor to MetafieldsSetPayload returnsMetafieldsSetPayload returns

Anchor to metafieldsmetafields •[Metafield!]
Anchor to userErrorsuserErrors •[UserError!]! non-null: List of errors that occured while executing the mutation.

Was this section helpful?

Examples

metafieldsSet reference

Mutation Reference

mutation metafieldsSet($metafields: [MetafieldSetInput!]!) {

metafieldsSet(metafields: $metafields) {

metafields {

# Metafield fields

}

userErrors {

field

message

}

Input

{

"metafields": [

{

"identifier": {

"key": "<your-key>",

"namespace": "<your-namespace>"

"value": "<your-value>"

}

]

}

Variables

{
  "metafields": [
    {
      "identifier": {
        "key": "<your-key>",
        "namespace": "<your-namespace>"
      },
      "value": "<your-value>"
    }
  ]
}

Schema

input MetafieldSetInput {
  identifier: CustomDataKeyPairInput!
  value: String!
}

input CustomDataKeyPairInput {
  key: String!
  namespace: String
}