Choose a version:

metafieldDefinitionCreate

mutation

Create a new MetafieldDefinition.

Anchor to Arguments

Arguments

Anchor to definitiondefinition

•MetafieldDefinitionCreateInput!

required

Was this section helpful?

Anchor to MetafieldDefinitionCreatePayload returnsMetafieldDefinitionCreatePayload returns

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

Was this section helpful?

Examples

metafieldDefinitionCreate reference

Mutation Reference

mutation metafieldDefinitionCreate($definition: MetafieldDefinitionCreateInput!) {

metafieldDefinitionCreate(definition: $definition) {

createdDefinition {

# MetafieldDefinition fields

}

userErrors {

field

message

}

Input

{

"definition": {

"access": {

"default": "ADMIN",

"grants": [

{}

]

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

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

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

"namespace": "<your-namespace>",

"type": "<your-type>",

"validations": [

{

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

"value": "<your-value>"

}

]

}

Variables

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

Schema

input MetafieldDefinitionCreateInput {
  access: CustomDataAccessInput
  description: String!
  key: String!
  name: String!
  namespace: String
  type: String!
  validations: [CustomDataMetafieldDefinitionValidationInput!]
}

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

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