validationCreate

mutation

Requires write_validations access scope.

Creates a validation.

Arguments

Anchor to validationvalidation • ValidationCreateInput!required: The input fields for a new validation.

Was this section helpful?

Anchor to ValidationCreatePayload returnsValidationCreatePayload returns

Anchor to userErrorsuserErrors • [ValidationUserError!]!non-null: The list of errors that occurred from executing the mutation.
Anchor to validationvalidation • Validation: The created validation.

Was this section helpful?

Mutation Reference

1mutation validationCreate($validation: ValidationCreateInput!) {
2  validationCreate(validation: $validation) {
3    userErrors {
4      field
5      message
6    }
7    validation {
8      # Validation fields
9    }
10  }
11}

Input

1{
2  "validation": {
3    "blockOnFailure": true,
4    "enable": true,
5    "functionId": "<your-functionId>",
6    "metafields": [
7      {
8        "description": "<your-description>",
9        "id": "gid://shopify/<objectName>/10079785100",
10        "key": "<your-key>",
11        "namespace": "<your-namespace>",
12        "type": "<your-type>",
13        "value": "<your-value>"
14      }
15    ],
16    "title": "<your-title>"
17  }
18}

{
  "validation": {
    "blockOnFailure": true,
    "enable": true,
    "functionId": "<your-functionId>",
    "metafields": [
      {
        "description": "<your-description>",
        "id": "gid://shopify/<objectName>/10079785100",
        "key": "<your-key>",
        "namespace": "<your-namespace>",
        "type": "<your-type>",
        "value": "<your-value>"
      }
    ],
    "title": "<your-title>"
  }
}

input ValidationCreateInput {
  blockOnFailure: Boolean
  enable: Boolean
  functionId: String!
  metafields: [MetafieldInput!]
  title: String
}

input MetafieldInput {
  description: String
  id: ID
  key: String
  namespace: String
  type: String
  value: String
}