Cancel a Scheduled Notification
Push Notifications
Cancel a Scheduled Notification
Stop a scheduled notification before it’s delivered.
POST
Cancel a Scheduled Notification
Cancels a notification that hasn’t been delivered yet — only valid while its
status is
On failure, the response follows the shape documented in Error & success codes.
scheduled. Deleting a notification’s row wouldn’t be enough on its
own since the delivery is asynchronous; this marks it canceled so the
scheduled-delivery job skips it when its time comes.
Calling this on a notification that’s already sent, failed, unsent, or
already canceled returns CANNOT_CANCEL_SENT_NOTIFICATION.
See the API introduction to set up your base URL and private key before making requests.
Parameters
string
required
The
notificationId returned when the notification was scheduled (see
Send a notification and its sentAt
parameter).string
required
Your private key from Project Settings.
Response
201 Created