Anchor to section titled 'undefined'

validationUpdate
mutation

Requires write_validations access scope.

Update a validation.

Anchor to section titled 'Arguments'

Arguments

Anchor to id
id
ID!
required

The ID representing the validation to update.

Anchor to validation
validation
ValidationUpdateInput!
required

The input fields to update a validation.

Was this section helpful?
Anchor to section titled 'ValidationUpdatePayload returns'

ValidationUpdatePayload returns

Anchor to ValidationUpdatePayload.userErrors
userErrors
[ValidationUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Anchor to ValidationUpdatePayload.validation
validation
Validation

The updated validation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation validationUpdate($id: ID!, $validation: ValidationUpdateInput!) {
  validationUpdate(id: $id, validation: $validation) {
    userErrors {
      field
      message
    }
    validation {
      # Validation fields
    }
  }
}
Hide code
Input
Copy
{
  "id": "gid://shopify/<objectName>/10079785100",
  "validation": {
    "blockOnFailure": true,
    "enable": true,
    "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 ValidationUpdateInput {
  blockOnFailure: Boolean
  enable: Boolean
  metafields: [MetafieldInput!]
  title: String
}

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