metaobjectUpdate
mutation

Choose a version:

Requires write_metaobjects access scope.

Updates an existing metaobject.

Anchor to section titled 'Arguments'

Arguments

Anchor to id id ID! required: The ID of the metaobject to update.
Anchor to metaobject metaobject MetaobjectUpdateInput! required: Specifies parameters to update on the metaobject.

Was this section helpful?

Anchor to section titled 'MetaobjectUpdatePayload returns'

MetaobjectUpdatePayload returns

Anchor to MetaobjectUpdatePayload.metaobject metaobject Metaobject: The updated metaobject.
Anchor to MetaobjectUpdatePayload.userErrors userErrors [MetaobjectUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: metaobjectUpdate

Query Reference for MUTATION: metaobjectUpdate

"mutation metaobjectUpdate($id: ID!, $metaobject: MetaobjectUpdateInput!) {\n  metaobjectUpdate(id: $id, metaobject: $metaobject) {\n    metaobject {\n      # Metaobject fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: metaobjectUpdate

"{\n  \"id\": \"gid://shopify/<objectName>/10079785100\",\n  \"metaobject\": {\n    \"capabilities\": {\n      \"onlineStore\": {\n        \"templateSuffix\": \"<your-templateSuffix>\"\n      },\n      \"publishable\": {\n        \"status\": \"ACTIVE\"\n      }\n    },\n    \"fields\": [\n      {\n        \"key\": \"<your-key>\",\n        \"value\": \"<your-value>\"\n      }\n    ],\n    \"handle\": \"<your-handle>\",\n    \"redirectNewHandle\": true\n  }\n}"

Schema Reference for MUTATION: metaobjectUpdate

"input MetaobjectUpdateInput {\n  capabilities: MetaobjectCapabilityDataInput\n  fields: [MetaobjectFieldInput!]\n  handle: String\n  redirectNewHandle: Boolean\n}\n\ninput MetaobjectCapabilityDataInput {\n  onlineStore: MetaobjectCapabilityDataOnlineStoreInput\n  publishable: MetaobjectCapabilityDataPublishableInput\n}\n\ninput MetaobjectFieldInput {\n  key: String!\n  value: String!\n}\n"

Display Examples for MUTATION: metaobjectUpdate

[
  {
    "example": {
      "type_name": "metaobjectupdate",
      "title": "Update a metaobject",
      "description": "To update an existing metaobject, you can use the `metaobjectUpdate` mutation with the `id`\nand `metaobject` arguments.\nThe following example updates the `season` field to be `winter` for the `fall-2021` \"LookBook\"\nmetaobject.\n",
      "query_string": "mutation UpdateMetaobject($id: ID!, $metaobject: MetaobjectUpdateInput!) {\n  metaobjectUpdate(id: $id, metaobject: $metaobject) {\n    metaobject {\n      handle\n      season: field(key: \"season\") {\n        value\n      }\n    }\n    userErrors {\n      field\n      message\n      code\n    }\n  }\n}",
      "variables": {
        "id": "gid://shopify/Metaobject/515107504",
        "metaobject": {
          "fields": [
            {
              "key": "season",
              "value": "winter"
            }
          ]
        }
      },
      "response": {
        "data": {
          "metaobjectUpdate": {
            "metaobject": {
              "handle": "fall-2021",
              "season": {
                "value": "winter"
              }
            },
            "userErrors": []
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/content/metaobjects/test/unit/graph_api/admin/mutations/metaobject_update_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation UpdateMetaobject($id: ID!, $metaobject: MetaobjectUpdateInput!) { metaobjectUpdate(id: $id, metaobject: $metaobject) { metaobject { handle season: field(key: \\\"season\\\") { value } } userErrors { field message code } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Metaobject/515107504\",\n    \"metaobject\": {\n      \"fields\": [\n        {\n          \"key\": \"season\",\n          \"value\": \"winter\"\n        }\n      ]\n    }\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation UpdateMetaobject($id: ID!, $metaobject: MetaobjectUpdateInput!) {\n    metaobjectUpdate(id: $id, metaobject: $metaobject) {\n      metaobject {\n        handle\n        season: field(key: \"season\") {\n          value\n        }\n      }\n      userErrors {\n        field\n        message\n        code\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/Metaobject/515107504\",\n      \"metaobject\": {\n        \"fields\": [\n          {\n            \"key\": \"season\",\n            \"value\": \"winter\"\n          }\n        ]\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 UpdateMetaobject($id: ID!, $metaobject: MetaobjectUpdateInput!) {\n    metaobjectUpdate(id: $id, metaobject: $metaobject) {\n      metaobject {\n        handle\n        season: field(key: \"season\") {\n          value\n        }\n      }\n      userErrors {\n        field\n        message\n        code\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/Metaobject/515107504\",\n  \"metaobject\": {\n    \"fields\": [{\"key\"=>\"season\", \"value\"=>\"winter\"}]\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 UpdateMetaobject($id: ID!, $metaobject: MetaobjectUpdateInput!) {\n      metaobjectUpdate(id: $id, metaobject: $metaobject) {\n        metaobject {\n          handle\n          season: field(key: \"season\") {\n            value\n          }\n        }\n        userErrors {\n          field\n          message\n          code\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/Metaobject/515107504\",\n      \"metaobject\": {\n        \"fields\": [\n          {\n            \"key\": \"season\",\n            \"value\": \"winter\"\n          }\n        ]\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 UpdateMetaobject($id: ID!, $metaobject: MetaobjectUpdateInput!) {\n    metaobjectUpdate(id: $id, metaobject: $metaobject) {\n      metaobject {\n        handle\n        season: field(key: \"season\") {\n          value\n        }\n      }\n      userErrors {\n        field\n        message\n        code\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/Metaobject/515107504\",\n  \"metaobject\" => [\n    \"fields\" => [{\"key\"=>\"season\", \"value\"=>\"winter\"}],\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "id",
          "description": "The ID of the metaobject to update.",
          "type": {
            "kind": "SCALAR",
            "name": "ID",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "ID!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "id",
        "argValue": " \"gid://shopify/Metaobject/515107504\"",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "metaobject",
          "description": "Specifies parameters to update on the metaobject.",
          "type": {
            "kind": "INPUT_OBJECT",
            "name": "MetaobjectUpdateInput",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "MetaobjectUpdateInput!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "metaobject",
        "argValue": " {\"fields\":[{\"key\":\"season\",\"value\":\"winter\"}]}",
        "typeKind": "MUTATION"
      }
    ]
  }
]

metaobjectUpdatemutation

Arguments

MetaobjectUpdatePayload returns

metaobjectUpdate
mutation