---
title: "Star an item"
method: PUT
path: "/v1/content/items/{id}/favourite"
tags: ["Content"]
---

# Star an item

`PUT /v1/content/items/{id}/favourite`

## Request

- Base URL: `https://api.banksync.io`
- URL: `https://api.banksync.io/v1/content/items/{id}/favourite`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Star or unstar an item for the key’s user. A star is one person’s, never the workspace’s.

## Path parameters

- `id` string, required: Item or folder ID, from the tree

## Headers

- `Idempotency-Key` string: Makes a retry safe: the same key with the same request replays the first answer for 24 hours instead of running twice, and the same key with a different request is a 409 `IDEMPOTENCY_KEY_REUSED`. Refusals a retry can outlive — 408, 409, 423, 425, 429 and every 5xx — are never replayed, so retrying with the same key after the cause clears runs the request.

## Request body

- object
  - `favourite` boolean, required: `true` stars the item for you; `false` unstars it

## Response `200`

The star

- object
  - `success` true, required
  - `data` object, required
    - `id` string, required
    - `favourite` boolean, required

## Other responses

- `400`: Invalid input, a folder cycle or a tree too deep, or an item of a kind this workspace does not arrange here (`CONTENT_UNKNOWN_KIND`)
- `401`: Unauthorized
- `403`: Forbidden — a missing scope, a role below editor for a change, or an installed app (the tree is the whole workspace’s)
- `404`: Not found — no such item or folder (`CONTENT_NOT_FOUND`), or the tree is not enabled for this workspace
- `409`: Conflict — the item changed since you read it (`CONTENT_VERSION_CONFLICT`: read it again), or it is in trash (`CONTENT_IN_TRASH`: restore it first)
- `429`: Too many requests — the key’s rate limit
- `503`: Changes are paused (`CONTENT_STOPPED`) or the tree is unavailable (`CONTENT_UNAVAILABLE`); retry shortly

---

[API](https://skmtc.dev/banksync/apis/banksync-api.md) · [All operations](https://skmtc.dev/banksync/apis/banksync-api/llms.txt) · [OpenAPI document](https://skmtc.dev/banksync/apis/banksync-api/revisions/94465f5ee922?raw)