Skip to content

Mark Notifications By Entity Read

PUT
/notifications/by-entity/read

Mark the whole team’s notifications for one record as READ.

The rows survive, stamped with who read them, so the bell can still show that someone acknowledged it. Idempotent: only unread rows are touched.

Omitting notification_type is the wide option - it marks every notification anyone in the org holds for that record, including mentions that were meant for a person.

Authorizations

Parameters

Query Parameters

entity_type
required

Record type the notification is about, e.g. chat.

string

Record type the notification is about, e.g. chat.

entity_id
required

Id of that record.

string

Id of that record.

notification_type
Any of:
string

Narrow to one notification type. Pass the type you own - omitting it also marks unrelated notifications on the same record, such as a colleague’s mention.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for one record, one dashboard or one job receipt.

Open because most of these reads are COMPUTED shapes - an engagement summary, a next-best-step, an intelligence status - that grow with the product, and dropping a field from an advisory read makes it say “nothing to report” rather than “we did not tell you”.

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
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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