Archive an inbox message

POST 
/api/v1/notifications/archive-inbox-message

Archives a single inbox message. Archived messages are hidden from the default feed but retained.

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

200

Message archived

Schema-valid request illustration; replace example identifiers and confirm operation prerequisites.

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

Request example

{
  "notificationId": "example_123"
}

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

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

Response example

{
  "status": {
    "acknowledged": true,
    "status": "example"
  }
}

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

Section	Stable reference
Archive an inbox message	DOC-CP-notifications-api-archiveInboxMessage#overview
Request	DOC-CP-notifications-api-archiveInboxMessage#request
Responses	DOC-CP-notifications-api-archiveInboxMessage#responses