Skip to main content

Cancel a scheduled notification

DELETE 
/v1/notifications/:notificationId

Required States: ACTIVE, VERIFIED, PROSPECT

This endpoint cancels a scheduled notification that has not yet been delivered.

Business Rules:

  • Only notifications with status 'NEW' or 'SCHEDULED_DELIVERY' can be cancelled
  • Cannot cancel already delivered, failed, or previously cancelled notifications
  • User must have appropriate permissions for the notification (own party context or admin)
  • Cancellation is processed at both the platform level and the connector level

Cancellation Process:

  1. Validates that the notification exists and can be cancelled
  2. Updates the notification status to 'CANCELLED' in the platform database
  3. Attempts to cancel the notification at the connector level
  4. Returns success even if connector-level cancellation fails (platform status takes precedence)

Channel-Specific Behavior:

  • SMS: Attempts to cancel via the SMS provider if the message is still in queue
  • EMAIL: Attempts to cancel via the email service if supported and message is queued
  • DEVICE: Attempts to cancel push notification via the push notification service if not yet delivered

Important Notes:

  • Connector-level cancellation may not be supported for all channels or providers
  • The response indicates success if the platform status was updated, regardless of connector outcome
  • Failed connector cancellations are logged for audit purposes but do not fail the request
  • Once a notification is marked as 'DELIVERED', it cannot be cancelled

Request​

Responses​

Notification cancelled successfully

Last updated on