v0 Platform API/API Reference/Chats

Favorite Chat

Marks or unmarks a chat as a favorite using its `chatId`. This helps with organizing and quickly accessing important chats.

PUT/v1/chats/{chatId}/favorite

Usage

TypeScript Example
import { v0 } from 'v0-sdk'

const result = await v0.chats.favorite({
  chatId: '123',
  isFavorite: true,
})

console.log(result)

API Signature

Request

Path Parameters

chatId: string

The unique identifier of the chat to update. Provided as a path parameter.

Body

isFavorite: boolean

Specifies whether the chat should be marked as a favorite.

  • "true": mark as favorite
  • "false": remove from favorites

Response

id: string
object: 'chat'
favorited: boolean