---
title: "Set favorite state for an item"
method: PUT
path: "/api/favorites"
tags: ["Favorites"]
---

# Set favorite state for an item

`PUT /api/favorites`

## Request body

- object
  - `itemType` 'page' | 'workflow' | 'schedule', required
  - `itemId` string, required
  - `favorite` boolean, required

## Response `200`

Favorite state

- object
  - `favorite` boolean, required
  - `itemType` 'page' | 'workflow' | 'schedule', required
  - `itemId` string, required
  - `row` UserFavorite, required
    - `id` string, required
    - `userId` string
    - `itemType` 'page' | 'workflow' | 'schedule', required
    - `itemId` string, required
    - `createdAt` string, required
    - `lastUpdatedAt` string, required
    - `createdBy` string
    - `updatedBy` string

## Other responses

- `401` — No authenticated principal context

## Changes

- **2026-08-07** `06cac6a7c5bc` — 2 info
  - added the media type `application/json` for the response with the status `200`
  - added the media type `application/json` for the response with the status `401`
- **2026-07-07** `61d2e881acf6` — 1 info
  - endpoint added
- **2026-07-02** `0c910612f9ac` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/desplega-ai/apis/agent-swarm-api/changes/api/favorites/put.md)

---

[API](https://skmtc.dev/desplega-ai/apis/agent-swarm-api.md) · [All operations](https://skmtc.dev/desplega-ai/apis/agent-swarm-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/desplega-ai/agent-swarm-api/revisions/e0acd2155cad/schema)