Choose a version:

metafieldNamespaceCreate

mutation

Create a new MetafieldNamespace.

Every client has their own implicit, reserved namespace; however, Namespaces allow sharing groups of Metafield Primitives and Access Grants together. Creating new Namespaces requires the client to have additional scope and is not available to all clients.

Anchor to Arguments

Arguments

Anchor to namespacenamespace

•MetafieldNamespaceCreateInput!

required

Was this section helpful?

Anchor to MetafieldNamespaceCreatePayload returnsMetafieldNamespaceCreatePayload returns

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

Was this section helpful?

Examples

metafieldNamespaceCreate reference

Mutation Reference

mutation metafieldNamespaceCreate($namespace: MetafieldNamespaceCreateInput!) {

metafieldNamespaceCreate(namespace: $namespace) {

createdNamespace {

# MetafieldNamespace fields

}

userErrors {

field

message

}

Input

{

"namespace": {

"access": {

"default": "ADMIN",

"grants": [

{}

]

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

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

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

"namespace": "<your-namespace>"

}

Variables

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

Schema

input MetafieldNamespaceCreateInput {
  access: CustomDataAccessInput
  description: String!
  key: String!
  name: String!
  namespace: String
}

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