Choose a version:

metafieldNamespaceUpdate

mutation

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

Anchor to Arguments

Arguments

Anchor to namespacenamespace

•MetafieldNamespaceUpdateInput!

required

Was this section helpful?

Anchor to MetafieldNamespaceUpdatePayload returnsMetafieldNamespaceUpdatePayload returns

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

Was this section helpful?

Examples

metafieldNamespaceUpdate reference

Mutation Reference

mutation metafieldNamespaceUpdate($namespace: MetafieldNamespaceUpdateInput!) {

metafieldNamespaceUpdate(namespace: $namespace) {

updatedNamespace {

# MetafieldNamespace fields

}

userErrors {

field

message

}

Input

{

"namespace": {

"access": {

"default": "ADMIN",

"grants": [

{}

]

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

"identifier": {

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

"namespace": "<your-namespace>"

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

"name": "<your-name>"

}

Variables

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

Schema

input MetafieldNamespaceUpdateInput {
  access: CustomDataAccessInput
  description: String
  identifier: CustomDataKeyPairInput!
  key: String
  name: String
}

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

input CustomDataKeyPairInput {
  key: String!
  namespace: String
}