v7

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01120263252.9 KB

Notifications

Update a scheduled notification

put/api/v1/deployments/{deploymentId}/notifications/{id}

deploymentIdinteger required

Numeric id of the deployment that owns the notification.

idinteger required

Numeric id of the notification (scheduled run).

customCronstring nullable

dayOfMonthinteger nullable

dayOfWeekinteger nullable

hourinteger nullable

isEnabledboolean nullable

Enable or disable the schedule

minuteinteger nullable

notificationEnabledboolean nullable

notificationFormat'png' | 'pdf'

scheduleType'HOURLY' | 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'CUSTOM'

timezonestring nullable

cronExpressionstring required

dashboardIdinteger required

deploymentIdinteger required

humanReadableSchedulestring required

Human-readable description of the cron schedule

idinteger required

isEnabledboolean required

notificationEnabledboolean required

notificationFormatstring required

timezonestring required