Cancel a scheduled notification

DELETE 
/v1/notifications/:notificationId

Cancel Scheduled Notification

This endpoint cancels a previously scheduled notification before it is sent.

Important: Only scheduled notifications can be cancelled. Notifications that have already been sent cannot be recalled.

Business Rule: Only notifications with status 'scheduled' or 'accepted' can be cancelled.

Authentication & Authorization:

• Requires valid service-to-service authentication
• Platform validates cancellation permissions before forwarding to connector

Cancellation Process:

• Connector attempts to cancel the notification with the external service
• Status is updated to CANCELLED in both connector and platform databases
• If cancellation fails (e.g., already sent), appropriate error is returned

Request

Responses

200

Notification cancelled successfully

401

Missing or invalid authentication token (GEN001002)

404

Notification not found (NOT004001)

412

Notification cannot be cancelled (NOT012001)

500

Vendor cancellation failed (NOT100006)