Inbox

Star Inbox Chat

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.

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

Path parameters

chat_idstring required

Chat id.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

is_starredboolean required

Response

Successful Response

dataobject required

Changes

No recorded changes to this operation across all 2 revisions of this API.