Skip to main content
PUT
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

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

deploymentId
integer
required

Numeric id of the deployment that owns the notification.

id
integer
required

Numeric id of the notification (scheduled run).

Body

application/json

UpdateNotificationInput

customCron
string | null
dayOfMonth
integer | null
dayOfWeek
integer | null
filters
object[] | null

Dimension filters applied to the dashboard when the notification is rendered. Replaces the existing set when provided.

hour
integer | null
isEnabled
boolean | null

Enable or disable the schedule

minute
integer | null
notificationEnabled
boolean | null
notificationFormat
enum<string> | null
Available options:
png,
pdf
scheduleType
enum<string> | null
Available options:
HOURLY,
DAILY,
WEEKLY,
MONTHLY,
CUSTOM
timeGrains
object[] | null

Time-grain overrides applied to the dashboard when the notification is rendered. Replaces the existing set when provided.

timezone
string | null

Response

200 - application/json
cronExpression
string
required
dashboardId
integer
required
deploymentId
integer
required
humanReadableSchedule
string
required

Human-readable description of the cron schedule

id
integer
required
isEnabled
boolean
required
notificationEnabled
boolean
required
notificationFormat
string
required
timezone
string
required
filters
object[] | null

Dimension filters applied when the notification is rendered.

timeGrains
object[] | null

Time-grain overrides applied when the notification is rendered.