Notifications

Mark a notification read

Marks one of YOUR OWN notifications read, or with all: true every unread one, optionally within a single module. It never sends, re-sends or deletes anything, and it can only ever touch the inbox of the member behind this credential — there is no argument for whose. Read state is set once and never cleared, so calling it twice is the same as calling it once and is never an error — safe to retry after a timeout. On an id the second call answers already_read: true with the moment it was first read; with all: true it answers changed: 0. An id that does not exist or belongs to somebody else answers not-found rather than confirming it exists. It answers with the fresh badge, so you do not need a follow-up count.

post/api/v1/rest/notifiche/inbox/read

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/notifiche/inbox/read
  • Auth: HTTP bearer

Headers

X-Tenant-Idstring uuid

The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.

Request body

idstring uuid

One notification, from notifiche_list_inbox. Omit only when all is true.

allboolean

Mark EVERY unread notification read instead of one. Explicit on purpose: read state is set once and never cleared, so this cannot be undone.

module'core' | 'documents' | 'conservazione' | 'anagrafiche' | 'tabelle' | 'email' | 'whatsapp' | 'protocolli' | 'workflow' | 'attivita' | 'checklist' | 'calendario' | 'crm' | 'spese' | 'timbratura' | 'firme' | 'raccolta' | 'condivisione' | 'integrazioni' | 'agenti' | 'bi' | 'ordini' | 'notifiche'

With all, restrict it to one module. Ignored when id is given.

Response

Done. data is the tool’s own answer.

oktrue required
dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.