---
title: "Star or unstar a table"
method: PUT
path: "/tables/{table_id}/favorite/"
tags: ["table-user-prefs"]
---

# Star or unstar a table

`PUT /tables/{table_id}/favorite/`

## Request

- Base URL: `https://api.getoneprofile.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getoneprofile.ai/tables/{table_id}/favorite/`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Set whether the CALLING USER has this table starred. Favourites are per-user, not per-organisation: starring a table does not star it for a teammate.

## Path parameters

- `table_id` string, uuid, required

## Request body

- TableFavoriteUpdateSchema: Request body for starring or unstarring a table.
  - `is_favorite` boolean, required: Whether this user wants the table starred.

## Response `200`

Successful Response

- TableUserPrefsReadSchema: One user's relationship with one table. Per-USER: two people in the same organisation are meant to disagree about what they have starred.
  - `is_favorite` boolean, required: Whether this user starred the table.
  - `last_viewed_at` string, date-time, nullable, required: When this user last opened the table; null means never.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Table not found
- `422`: Invalid request made to the API.
- `500`: Internal server error.
- `502`: Bad gateway error.
- `503`: Service unavailable.

---

[API](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile.md) · [All operations](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/llms.txt) · [OpenAPI document](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/revisions/4a6bd71e3f02?raw)