Choose a version:

automationWorkflowDeactivate

mutation

Requires write_automations access scope. Also: The app must have write access to automations and act on behalf of a user.

Deactivates a specific automation version and cancels its runs. An action already executing may still finish.

Arguments

Anchor to idid •ID! required: The ID of the automation to deactivate.
Anchor to versionversion •String! required: The version to deactivate. Deactivating an inactive version succeeds without making changes.

Was this section helpful?

Anchor to automationWorkflowautomationWorkflow •AutomationWorkflow: The automation version after deactivation. Returns null if an error is raised.

Show fields
Anchor to userErrorsuserErrors •[AutomationWorkflowUserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

mutation automationWorkflowDeactivate($id: ID!, $version: String!) {

automationWorkflowDeactivate(id: $id, version: $version) {

automationWorkflow {

# AutomationWorkflow fields

}

userErrors {

field

message

}

{

"id": "gid://shopify/AutomationWorkflow/10079785100",

"version": "<your-version>"

}