Notifications

Delete Notifications By Entity

Delete the whole team's notifications for one record.

Removes the rows for every user in your organisation, not just the caller's. There is no undo, and unlike the read marker above nothing survives to show the notification existed - prefer PUT /notifications/by-entity/read unless the notification was noise.

delete/notifications/by-entity

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/notifications/by-entity
  • Auth: HTTP bearer

Query parameters

entity_typestring required

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

entity_idstring required

Id of that record.

notification_typestring nullable

Narrow to one notification type. Pass the type you own - omitting it also deletes unrelated notifications on the same record.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataCrmRecordPayload 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".

Changes

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