Notifications

Update a scheduled notification

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

Request

  • Base URL: https://your-tenant.cubecloud.dev
  • URL: https://your-tenant.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications/{id}
  • Auth: HTTP bearer

Path parameters

deploymentIdinteger required

Numeric id of the deployment that owns the notification.

idinteger required

Numeric id of the notification (scheduled run).

Request body

customCronstring nullable
dayOfMonthinteger nullable
dayOfWeekinteger nullable
hourinteger nullable
isEnabledboolean nullable

Enable or disable the schedule

minuteinteger nullable
notificationAiSummaryboolean nullable

Include an AI-generated "what changed" summary in the notification body. Off by default.

notificationEnabledboolean nullable
notificationFormat'png' | 'pdf' | 'pdf_print'
scheduleType'HOURLY' | 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'CUSTOM'
timezonestring nullable

Response

cronExpressionstring required
dashboardIdinteger required
deploymentIdinteger required
humanReadableSchedulestring required

Human-readable description of the cron schedule

idinteger required
isEnabledboolean required
notificationAiSummaryboolean required

Whether this notification carries an AI-generated "what changed" summary in its body.

notificationEnabledboolean required
notificationFormatstring required
timezonestring required

Changes

  • adc4919489f4Revision changes
    • warning

      added the new in_month enum value to the /////// response property for the response status

    • warning

      added the new in_quarter enum value to the /////// response property for the response status

    • warning

      added the new in_year enum value to the /////// response property for the response status

    • warning

      added the new not_in_month enum value to the /////// response property for the response status

    • warning

      added the new not_in_quarter enum value to the /////// response property for the response status

    • warning

      added the new not_in_year enum value to the /////// response property for the response status

    • info

      added the new in_month enum value to the request property ///////

    • info

      added the new in_quarter enum value to the request property ///////

    • info

      added the new in_year enum value to the request property ///////

    • info

      added the new not_in_month enum value to the request property ///////

    • info

      added the new not_in_quarter enum value to the request property ///////

    • info

      added the new not_in_year enum value to the request property ///////

  • 1091747b43b9Revision changes
    • info

      added the new pdf_print enum value to the request property ////