Skip to main content

Archive all read inbox messages

POST 
/api/v1/notifications/archive-all-read-inbox-messages

Archives every already-read inbox message for the authenticated user. Optionally scoped to specific workflow tags (OR logic).

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized scoped domain action.

Use this in a guide: Build an in-app inbox

Request​

Responses​

Read messages archived

Archive all read messages in the selected user’s inbox; no tag filter is supplied.​

Section ID: DOC-CP-notifications-api-archiveAllReadInboxMessages#example-notifications-archiveAllReadInboxMessages-request

Request example

{}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.​

Section ID: DOC-CP-notifications-api-archiveAllReadInboxMessages#example-notifications-archiveAllReadInboxMessages-response

Response example

{
  "archivedCount": 1
}

Document ID: DOC-CP-notifications-api-archiveAllReadInboxMessages. Section identities and revisions.

SectionStable reference
Archive all read inbox messagesDOC-CP-notifications-api-archiveAllReadInboxMessages#overview
RequestDOC-CP-notifications-api-archiveAllReadInboxMessages#request
ResponsesDOC-CP-notifications-api-archiveAllReadInboxMessages#responses