Skip to main content

Cancel a pending notification

POST 

/api/v1/notifications/manage/cancel

Requests cancellation of pending/scheduled provider work by transaction ID. It does not recall notifications already handed to a channel or undo an action the recipient performed. Inspect the cancellation result and preserve uncertainty when delivery is in flight.

Cancellation outcomes​

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

Request​

Responses​

Cancellation result

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

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