Skip to main content
PUT
/
v1
/
deployments
/
{deploymentId}
/
notifications
/
{id}
Update a scheduled notification
curl --request PUT \
  --url https://{tenant}.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customCron": "<string>",
  "dayOfMonth": 123,
  "dayOfWeek": 123,
  "hour": 123,
  "isEnabled": true,
  "minute": 123,
  "notificationEnabled": true,
  "timezone": "<string>"
}
'
{
  "cronExpression": "<string>",
  "dashboardId": 123,
  "deploymentId": 123,
  "humanReadableSchedule": "<string>",
  "id": 123,
  "isEnabled": true,
  "notificationEnabled": true,
  "notificationFormat": "<string>",
  "timezone": "<string>"
}

Authorizations

Authorization
string
header
required

API key authentication. Send Authorization: Api-Key <YOUR_API_KEY>.

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
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
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