---
title: "Star Inbox Chat"
method: PUT
path: "/inbox/chats/{chat_id}/star"
tags: ["Inbox"]
---

# Star Inbox Chat

`PUT /inbox/chats/{chat_id}/star`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/inbox/chats/{chat_id}/star`
- Auth: HTTP bearer

SET the starred state. `is_starred` is required and is not a toggle.

A toggle is not idempotent: a retried request would silently un-star the
thread it just starred. A PUT with an explicit value is safe to retry,
which is why the app models it this way and why this surface does not
"helpfully" make the field optional.

## Path parameters

- `chat_id` string, required: Chat id.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- ChatStarRequest: Set, rather than toggle, the starred state. Declared as a required bool for exactly that reason: a toggle is not idempotent, so a retried request would silently un-star the thread it just starred.
  - `is_starred` boolean, required

## Response `200`

Successful Response

- ApiResponseDict
  - `data` object, required
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/89fc11143b70?raw)