Choose a version:

metafieldDefinitionUpdate

mutation

Update a MetafieldDefinition by changing its key, name, description, capabilities, or access.

Anchor to Arguments

Arguments

Anchor to definitiondefinition

•MetafieldDefinitionUpdateInput!

required

Was this section helpful?

Anchor to MetafieldDefinitionUpdatePayload returnsMetafieldDefinitionUpdatePayload returns

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

Was this section helpful?

Examples

metafieldDefinitionUpdate reference

Mutation Reference

mutation metafieldDefinitionUpdate($definition: MetafieldDefinitionUpdateInput!) {

metafieldDefinitionUpdate(definition: $definition) {

updatedDefinition {

# MetafieldDefinition fields

}

userErrors {

field

message

}

Input

{

"definition": {

"access": {

"default": "ADMIN",

"grants": [

{}

]

"description": "<your-description>",

"identifier": {

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

"namespace": "<your-namespace>"

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

"name": "<your-name>",

"validations": [

{

"name": "<your-name>",

"value": "<your-value>"

}

]

}

Variables

{
  "definition": {
    "access": {
      "default": "ADMIN",
      "grants": [
        {}
      ]
    },
    "description": "<your-description>",
    "identifier": {
      "key": "<your-key>",
      "namespace": "<your-namespace>"
    },
    "key": "<your-key>",
    "name": "<your-name>",
    "validations": [
      {
        "name": "<your-name>",
        "value": "<your-value>"
      }
    ]
  }
}

Schema

input MetafieldDefinitionUpdateInput {
  access: CustomDataAccessInput
  description: String
  identifier: CustomDataKeyPairInput!
  key: String
  name: String
  validations: [CustomDataMetafieldDefinitionValidationInput!]
}

input CustomDataAccessInput {
  default: CustomDataAccessPermissionType
  grants: [CustomDataAccessGrantInput!]
}

input CustomDataKeyPairInput {
  key: String!
  namespace: String
}

input CustomDataMetafieldDefinitionValidationInput {
  name: String!
  value: String!
}