Skip to content

Update an Automation

Change automation metadata, team boundaries, scopes, or suspension state without recreating the automation.

Best for Workspace manager Updated April 3, 2026
API In this interface
4 steps Steps
3 interfaces Available in
Use this path when

Use the automation patch endpoint when automation or admin tooling should change automation state.

What you'll finish here
  • Edit the correct automation.
  • Narrow scopes safely.
  • Suspend access without deleting context.

Where this happens

LabelValueNotes
EndpointPATCH /api/v1/workspaces/{workspaceId}/automations/{automationId}Updates an automation.

Same Task, Other Interfaces

Use the version that matches where you are working now. The subject matter stays the same; the delivery changes by surface.

Do the work

  1. 1. Identify the correct workspace id and automation id first.
  2. 2. Send only the fields that should change.
  3. 3. Use `description: null` when the description should be cleared.
  4. 4. Set `suspended` to `true` or `false` when the change is about access state rather than metadata.

Keep Going in Automation and Agents

Stay in the same interface and move to the next closest task in this topic when needed.

Nearby Guides

These guides stay close to the current workflow so you can keep moving without restarting discovery.