Skip to main content

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​

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.

Request​

Responses​

Digest event cancellation result

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

SectionStable reference
OverviewDOC-CP-notifications-api-cancelDigestEvent#overview
RequestDOC-CP-notifications-api-cancelDigestEvent#request
ResponsesDOC-CP-notifications-api-cancelDigestEvent#responses