Skip to content

Star Inbox Chat

PUT
/inbox/chats/{chat_id}/star

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.

Authorizations

Parameters

Path Parameters

chat_id
required

Chat id.

string

Chat id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

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.

object
is_starred
required
boolean

Responses

200

Successful Response

object
data
required
object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string