Edit Automation

Use the editAutomation mutation to update an existing automation’s trigger, actions, or active state. Every field except automationId is optional, so you can flip an automation on or off, swap its actions, or reconfigure its trigger without resending the parts you aren’t changing. Automations are Automation objects in the API.

trigger and actions reuse the same input types as Create Automation — CreateAutomationTriggerInput and CreateAutomationActionInput. See that page for the full field reference. The semantics on edit differ in one important way: each block, when supplied, fully replaces the existing configuration (see How replacement works).

Request

The smallest call deactivates an automation by id. Pass the workspace context in the blue-workspace-id header (ID or slug).

mutation EditAutomation {
  editAutomation(input: { automationId: "automation_123", isActive: false }) {
    id
    isActive
    updatedAt
  }
}

Parameters

EditAutomationInput

For the full CreateAutomationTriggerInput and CreateAutomationActionInput field tables (including the schedule block, trigger types, and action types), see Create Automation.

Response

{
  "data": {
    "editAutomation": {
      "id": "clm4n8qwx000008l0g4oxdqn7",
      "isActive": false,
      "updatedAt": "2026-05-29T14:22:07.000Z"
    }
  }
}

Returns

The mutation returns the updated Automation.

Full example

Reconfigure a TODO_LIST_CHANGED trigger and replace the action set. Because trigger and actions each replace the existing configuration wholesale, send the complete desired state for both.

mutation EditAutomationAdvanced {
  editAutomation(
    input: {
      automationId: "automation_123"
      isActive: true
      trigger: { type: TODO_LIST_CHANGED, todoListId: "list_123", tagIds: ["tag_123"] }
      actions: [
        { type: ADD_ASSIGNEE, assigneeIds: ["user_123"] }
        { type: CHANGE_DUE_DATE, duedIn: 14 }
        {
          type: SEND_EMAIL
          metadata: {
            email: {
              to: ["team@example.com"]
              from: "noreply@example.com"
              subject: "Updated automation triggered"
              content: "<p>An automation has been triggered.</p>"
            }
          }
        }
      ]
    }
  ) {
    id
    isActive
    trigger {
      id
      type
      todoList {
        id
        title
      }
      tags {
        id
        title
      }
    }
    actions {
      id
      type
      duedIn
      assignees {
        id
        fullName
      }
      metadata {
        ... on AutomationActionMetadataSendEmail {
          email {
            subject
            to
          }
        }
      }
    }
    createdBy {
      id
      fullName
    }
    updatedAt
  }
}

How replacement works

Supplying trigger or actions replaces — never merges — the existing configuration.

• Trigger. The trigger row keeps its id, but its field values are rewritten from the CreateAutomationTriggerInput you send. Any scalar you omit reverts to that input’s default rather than retaining its prior value. To change one setting, re-send the full desired trigger config (including its type).
• Schedule. SCHEDULED triggers carry a nested schedule block. Because the trigger input fully replaces, you must include the complete schedule again when editing a scheduled automation — otherwise the schedule is dropped. Changing a trigger to or from SCHEDULED automatically registers or removes the underlying schedule job.
• Actions. Providing actions deletes the existing actions and creates the new list. To keep an existing action, include it again in the array.
• Due-date triggers. Edits to a DUE_DATE_EXPIRED trigger (and toggling isActive on one) automatically update its monitoring job.

Errors

An automation in a workspace you have no access to is looked up successfully but rejected for lack of permission, so it returns FORBIDDEN — not AUTOMATION_NOT_FOUND. AUTOMATION_NOT_FOUND fires only when the id truly does not exist.

Permissions

Only an OWNER or ADMIN of an active (non-archived) workspace can edit automations.

Related

• Create Automation
• Copy Automation
• Delete Automation