Choose a version:

automationWorkflowUpdate

mutation

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

Updates an automation's name, tags, note, or configuration. Supply at least one editable field. Omitted fields keep their existing values.

Replacing the configuration edits the latest draft in place, or creates a draft if none exists. Any active version continues running with its existing configuration. Changes to the name, tags, or note don't create a draft.

Input errors are returned in userErrors and nothing is saved. A saved version can still have validationErrors; fix those before activating it.

Anchor to Arguments

Arguments

Anchor to configurationconfiguration •JSON: The full replacement JSON configuration, including __metadata.version and root. Replaces the steps, links, and custom fields (root.patched_fields). Supply name, tags, and note as separate arguments; root.workflow_name, root.tags, and root.note are rejected. Omit to leave the configuration unchanged. Null is rejected. See the workflow configuration JSON Schema.
Anchor to idid •ID! required: The ID of the automation to update.
Anchor to namename •String: The new automation name, shared by all versions. Omit to leave it unchanged. Null and blank names are rejected.
Anchor to notenote •String: The note for the version being updated. Omit to leave it unchanged; use null to clear it.
Anchor to tagstags •[String!]: The replacement tags, shared by all versions. Omit or use null to leave them unchanged; use an empty list to clear them.
Anchor to versionversion •String! required: The version this edit is based on. Use the latest draft, or the most recently published version when no draft exists. A different version returns OUTDATED_WORKFLOW. Edits within the same draft and changes to name, tags, or note keep this identifier, so the check can't detect those edits.

Was this section helpful?

Anchor to AutomationWorkflowUpdatePayload returnsAutomationWorkflowUpdatePayload returns

Anchor to automationWorkflowautomationWorkflow •AutomationWorkflow: The saved automation version. Replacing the configuration returns a draft. 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?

Examples

automationWorkflowUpdate reference

Mutation Reference

mutation automationWorkflowUpdate($configuration: JSON, $id: ID!, $name: String, $note: String, $tags: [String!], $version: String!) {

automationWorkflowUpdate(configuration: $configuration, id: $id, name: $name, note: $note, tags: $tags, version: $version) {

automationWorkflow {

# AutomationWorkflow fields

}

userErrors {

field

message

}

Input

{

"configuration": "{ \"name\": \"Size\", \"values\": [\"M\", \"L\"] }",

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

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

"note": "<your-note>",

"tags": [

"<your-tags>"

"version": "<your-version>"

}

Variables

{
  "configuration": "{ \"name\": \"Size\", \"values\": [\"M\", \"L\"] }",
  "id": "gid://shopify/AutomationWorkflow/10079785100",
  "name": "<your-name>",
  "note": "<your-note>",
  "tags": [
    "<your-tags>"
  ],
  "version": "<your-version>"
}