Choose a version:

metaobjectDefinitionUpdate

mutation

Requires write_metaobject_definitions access scope.

Updates a metaobject definition with new settings and metafield definitions.

Arguments

Anchor to definitiondefinition •MetaobjectDefinitionUpdateInput!required: The input fields for updating a metaobject definition.
Anchor to idid •ID!required: The ID of the metaobject definition to update.

Was this section helpful?

Anchor to MetaobjectDefinitionUpdatePayload returnsMetaobjectDefinitionUpdatePayload returns

Anchor to metaobjectDefinitionmetaobjectDefinition •MetaobjectDefinition: The updated metaobject definition.
Anchor to userErrorsuserErrors •[MetaobjectUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Create additional field definitions on an existing metaobject definition
Delete a field definition from a metaobject definition
Update an existing field definition on a metaobject definition
Update base attributes of a metaobject definition
Update ordering of fields on an existing metaobject definition
metaobjectDefinitionUpdate reference

Examples

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation UpdateMetaobjectDefinition($id: ID!, $definition: MetaobjectDefinitionUpdateInput!) {

metaobjectDefinitionUpdate(id: $id, definition: $definition) {

metaobjectDefinition {

name

displayNameKey

fieldDefinitions {

name

key

type {

name

}

userErrors {

field

message

code

}

}`,

{

variables: {

"id": "gid://shopify/MetaobjectDefinition/578408816",

"definition": {

"displayNameKey": "description",

"fieldDefinitions": [

{

"create": {

"key": "description",

"name": "Description",

"type": "single_line_text_field"

}

]

}

);

const data = await response.json();

mutation UpdateMetaobjectDefinition($id: ID!, $definition: MetaobjectDefinitionUpdateInput!) {
  metaobjectDefinitionUpdate(id: $id, definition: $definition) {
    metaobjectDefinition {
      id
      name
      displayNameKey
      fieldDefinitions {
        name
        key
        type {
          name
        }
      }
    }
    userErrors {
      field
      message
      code
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation UpdateMetaobjectDefinition($id: ID!, $definition: MetaobjectDefinitionUpdateInput!) { metaobjectDefinitionUpdate(id: $id, definition: $definition) { metaobjectDefinition { id name displayNameKey fieldDefinitions { name key type { name } } } userErrors { field message code } } }",
 "variables": {
    "id": "gid://shopify/MetaobjectDefinition/578408816",
    "definition": {
      "displayNameKey": "description",
      "fieldDefinitions": [
        {
          "create": {
            "key": "description",
            "name": "Description",
            "type": "single_line_text_field"
          }
        }
      ]
    }
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation UpdateMetaobjectDefinition($id: ID!, $definition: MetaobjectDefinitionUpdateInput!) {
    metaobjectDefinitionUpdate(id: $id, definition: $definition) {
      metaobjectDefinition {
        id
        name
        displayNameKey
        fieldDefinitions {
          name
          key
          type {
            name
          }
        }
      }
      userErrors {
        field
        message
        code
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/MetaobjectDefinition/578408816",
      "definition": {
        "displayNameKey": "description",
        "fieldDefinitions": [
          {
            "create": {
              "key": "description",
              "name": "Description",
              "type": "single_line_text_field"
            }
          }
        ]
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation UpdateMetaobjectDefinition($id: ID!, $definition: MetaobjectDefinitionUpdateInput!) {
      metaobjectDefinitionUpdate(id: $id, definition: $definition) {
        metaobjectDefinition {
          id
          name
          displayNameKey
          fieldDefinitions {
            name
            key
            type {
              name
            }
          }
        }
        userErrors {
          field
          message
          code
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/MetaobjectDefinition/578408816",
      "definition": {
        "displayNameKey": "description",
        "fieldDefinitions": [
          {
            "create": {
              "key": "description",
              "name": "Description",
              "type": "single_line_text_field"
            }
          }
        ]
      }
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation UpdateMetaobjectDefinition($id: ID!, $definition: MetaobjectDefinitionUpdateInput!) {
    metaobjectDefinitionUpdate(id: $id, definition: $definition) {
      metaobjectDefinition {
        id
        name
        displayNameKey
        fieldDefinitions {
          name
          key
          type {
            name
          }
        }
      }
      userErrors {
        field
        message
        code
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/MetaobjectDefinition/578408816",
  "definition": {
    "displayNameKey": "description",
    "fieldDefinitions": [{"create"=>{"key"=>"description", "name"=>"Description", "type"=>"single_line_text_field"}}]
  }
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"id": "gid://shopify/MetaobjectDefinition/578408816",

"definition": {

"displayNameKey": "description",

"fieldDefinitions": [

{

"create": {

"key": "description",

"name": "Description",

"type": "single_line_text_field"

}

]

}

Response

JSON

{

"metaobjectDefinitionUpdate": {

"metaobjectDefinition": {

"id": "gid://shopify/MetaobjectDefinition/578408816",

"name": "LookBook",

"displayNameKey": "description",

"fieldDefinitions": [

{

"name": "Another Lookbook",

"key": "another_lookbook",

"type": {

"name": "metaobject_reference"

}

{

"name": "Season",

"key": "cover_image",

"type": {

"name": "file_reference"

}

{

"name": "Season",

"key": "season",

"type": {

"name": "single_line_text_field"

}

{

"name": "Year",

"key": "year",

"type": {

"name": "number_integer"

}

{

"name": "Description",

"key": "description",

"type": {

"name": "single_line_text_field"

}

]

"userErrors": []

}