Skip to main content

Complete an inbox message action

POST 
/api/v1/notifications/complete-inbox-action

Marks an inbox action button completed. This changes inbox presentation state; it does not execute or authorize the business operation behind that button. Verify the actual business operation separately.

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​

Action completed

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

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

Request example

{
  "notificationId": "example_123",
  "actionType": "ACTION_TYPE_PRIMARY"
}

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

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

Response example

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

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

SectionStable reference
Complete an inbox message actionDOC-CP-notifications-api-completeInboxAction#overview
RequestDOC-CP-notifications-api-completeInboxAction#request
ResponsesDOC-CP-notifications-api-completeInboxAction#responses