Skip to main content

Delete an inbox message

POST 

/api/v1/notifications/delete-inbox-message

Deletes the specified inbox message in the effective user’s inbox. This does not recall copies already delivered through other channels or attest to backup erasure.

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 deleted successfully

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

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

Request example

{
"messageId": "example_123"
}

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

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

Response example

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

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

SectionStable reference
Delete an inbox messageDOC-CP-notifications-api-deleteInboxMessage#overview
RequestDOC-CP-notifications-api-deleteInboxMessage#request
ResponsesDOC-CP-notifications-api-deleteInboxMessage#responses