---
title: "Favorite Automation"
method: PUT
path: "/api/v1/automations/{automation_id}/favorite"
tags: ["automations"]
---

# Favorite Automation

`PUT /api/v1/automations/{automation_id}/favorite`

Pin the workflow to the top of the caller's list. Idempotent; viewer+.

## Path parameters

- `automation_id` string, uuid, required

## Response `200`

Successful Response

- AutomationRead
  - `id` string, uuid, required
  - `company_id` string, uuid, required
  - `name` string, required
  - `description` string, nullable, required
  - `status` 'draft' | 'active' | 'paused' | 'archived', required — Top-level status of an automation.
  - `created_by` string, uuid, required
  - `created_at` string, required
  - `updated_at` string, required
  - `activated_at` string, nullable, required
  - `is_suppressed` boolean, required
  - `nodes` NodeRead[], required
    - `id` string, uuid, required
    - `slug` string, required
    - `kind` 'trigger.schedule' | 'trigger.entity_change' | 'trigger.app_invocation' | 'fetch_entities' | 'query' | 'update_entity_row' | 'create_entity_row' | 'load_scenario_revision' | 'custom_code' | 'dataset_sink' | 'if' | 'aggregate_to_one' | 'ai_step' | 'send_email' | 'http_request' | 'provider_action', required — All v1 node kinds. Triggers + body nodes share one enum + one table.
    - `config` object, required
    - `position_x` integer, nullable, required
    - `position_y` integer, nullable, required
  - `edges` EdgeRead[], required
    - `id` string, uuid, required
    - `from_node_id` string, uuid, required
    - `to_node_id` string, uuid, required
    - `port` string, required
  - `current_user_level` 'viewer' | 'editor' | 'admin' — Permission tiers, strictly ordered VIEWER < EDITOR < ADMIN.
  - `is_favorite` boolean

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/netter/apis/dmi-backend.md) · [All operations](https://skmtc.net/netter/apis/dmi-backend/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/netter/dmi-backend/versions/a59877bf911b/schema)