Cancel a pending digest event

POST 
/api/v1/notifications/manage/cancel-digest-event

Cancels a specific event from a pending digest. If the digest has already been sent, this has no effect.

Cancellation outcomes

Section ID: DOC-CP-notifications-api-cancelDigestEvent#cancellation-outcomes

An already processed digest event can return HTTP 200 with cancelled: false and a message that it may already have been processed. Inspect cancelled rather than relying on HTTP status alone.

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: Send notifications

Request

Responses

200

Digest event cancellation result

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

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

Request example

{
  "transactionId": "example_123"
}

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

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

Response example

{
  "cancelled": true,
  "message": "example"
}

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

Section	Stable reference
Cancel a pending digest event	DOC-CP-notifications-api-cancelDigestEvent#overview
Request	DOC-CP-notifications-api-cancelDigestEvent#request
Responses	DOC-CP-notifications-api-cancelDigestEvent#responses