Update a scheduled notification
🔒 Admin only. Requires administrator privileges — the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role.
Updates a notification’s schedule definition. Any subset of the schedule fields may be supplied (scheduleType + time fields or customCron, timezone), along with isEnabled, notificationEnabled, and notificationFormat. Omitted fields are left unchanged. This endpoint never modifies recipients — manage those through the /recipients sub-resource. Returns 404 if the notification is not part of this deployment.
Authorizations
API key authentication. Send Authorization: Api-Key <YOUR_API_KEY>.
Path Parameters
Numeric id of the deployment that owns the notification.
Numeric id of the notification (scheduled run).
Body
UpdateNotificationInput
Enable or disable the schedule
png, pdf HOURLY, DAILY, WEEKLY, MONTHLY, CUSTOM Response
Human-readable description of the cron schedule