Skip to main content

Mark a single inbox message

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

Marks a specific inbox message as seen, read, unseen, or unread.

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​

Message marked successfully

Mark an existing inbox message as read.​

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

Request example

{
  "messageId": "msg_123",
  "markAs": "MESSAGE_STATUS_READ"
}

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

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

Response example

{
  "messages": [
    {
      "messageId": "example_123",
      "channel": "example",
      "read": true,
      "seen": true,
      "archived": true,
      "content": "Example text",
      "subject": "example",
      "status": "example",
      "createdAt": "example",
      "lastReadDate": "example",
      "lastSeenDate": "example"
    }
  ]
}

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

SectionStable reference
Mark a single inbox messageDOC-CP-notifications-api-markInboxMessageAs#overview
RequestDOC-CP-notifications-api-markInboxMessageAs#request
ResponsesDOC-CP-notifications-api-markInboxMessageAs#responses