Cancel Scheduled Notification Instance

Delete a queued notification instance before its scheduled delivery time. Only notification instances with a QUEUED delivery state can be cancelled. Requires ADMIN permissions.

Parameters

name * are required parameters	data type	description
notificationInstanceId*	string	The unique identifier of the notification instance to cancel

Return Value

{
  "statusCode": 200,
  "data": {
    "cancelled": true,
    "state": "QUEUED"
  },
  "message": "Scheduled notification instance cancelled"
}

Returns 404 when the notification instance does not exist and 409 when it is no longer queued.

Examples

bash

curl -X DELETE "https://app.wombat.software/api/{targetPath}/notice/:notificationInstanceId" \
  -H "Authorization: Bearer ..."