Update Automation

Before You Begin

Use the GraphQL Playground.
Authenticate with a Service Account token.

Prerequisites

You must have admin permission on the automation's repository to update it.
You need the automation ID to update. See Retrieve automations to find automation IDs.

Update an Automation

Basic example (update automation name and status)

Inputs

id: The automation ID to update. Get this from Retrieve automations.
input.name: New display name for the automation.
input.active: Boolean to enable/disable the automation.

mutation {
  updateAutomation(input: {
    id: "22"
    name: "Updated AI Translation Automation"
    active: false
  }) {
    automation {
      id
      name
      action_id
      event_id
      action_repo_v2 { ... on Pipe { id } ... on Table { id } }
      event_repo { id }
      active
    }
    error_details {
      object_name
      object_key
      messages
    }
  }
}

Response:

{
  "data": {
    "updateAutomation": {
      "automation": {
        "id": "22",
        "name": "Updated AI Translation Automation",
        "action_id": "update_card_field",
        "event_id": "card_moved",
        "action_repo_v2": {
          "id": "23"
        },
        "event_repo": {
          "id": "23"
        },
        "active": false
      },
      "error_details": null
    }
  }
}

Response explained

automation.id: The automation identifier (unchanged).
automation.name: Updated display name for the automation.
automation.action_id/event_id: Original action and event identifiers (unchanged).
action_repo_v2.id / event_repo.id: Repository/Pipe IDs where the automation operates.
automation.active: Updated status - true for enabled, false for disabled.
error_details: Null when update succeeds; otherwise includes validation errors.

Error handling example

If the automation doesn't exist or you don't have permission to update it, you'll receive an error response:

{
  "data": {
    "updateAutomation": null
  },
  "errors": [
    {
      "message": "Permission Denied - Make sure you have permission to manage automations or check that you are a member of the event and action's Pipes or Database.",
      "locations": [
        {
          "line": 18,
          "column": 3
        }
      ],
      "path": [
        "updateAutomation"
      ],
      "extensions": {
        "code": "PERMISSION_DENIED",
        "correlation_id": "507ad954-b994-4375-926e-ea3d5c4b6c37"
      }
    }
  ]
}

Error response explained

data.updateAutomation: Returns null when the operation fails.
errors: Array containing error details when the operation fails.
errors[].message: Human-readable error description.
errors[].extensions.code: Error code (e.g., PERMISSION_DENIED) - see Status and error handling for complete error codes list.
errors[].extensions.correlation_id: Unique identifier for support assistance.

Conditions

The optional condition field filters when an automation actually executes after the event fires. For the full reference, see Conditions.

Events and Actions Parameters

For the full reference of event_params and action_params accepted by each event and action, see:

Tips

Verify before updating: Use Retrieve automations to confirm the automation ID and current settings.
Check permissions: Ensure you have admin access to the automation's repository before attempting updates.
Partial updates: You can update individual fields without affecting others. Only include the fields you want to change.
Status management: Use active: false to temporarily disable an automation instead of deleting it.
Error handling: Always check the errors array in the response to handle potential errors gracefully. For complete error codes and handling guidance, see Status and error handling.