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

Section ID: DOC-CP-notifications-api-cancelNotification#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.

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

Cancellation result

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

Section ID: DOC-CP-notifications-api-cancelNotification#example-notifications-cancelNotification-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-cancelNotification#example-notifications-cancelNotification-response

Response example

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

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

Section	Stable reference
Cancel a pending notification	DOC-CP-notifications-api-cancelNotification#overview
Request	DOC-CP-notifications-api-cancelNotification#request
Responses	DOC-CP-notifications-api-cancelNotification#responses