UpdateScheduleBody

Request body for updating a Schedule.

Definition

TypeScript

interface UpdateScheduleBody {
  name?: string | undefined;
  cronExpr?: string | undefined;
  timezone?: string | undefined;
  missedRunPolicy?: "skip" | "fire" | undefined;
  payload?: Record<string, unknown> | null | undefined;
  enabled?: boolean | undefined;
  runtimeUserId?: string | null | undefined;
}

Fields

Field	Type	Notes
`name`	`string \| undefined`	`optional` — New display name.
`cronExpr`	`string \| undefined`	`optional` — New cron expression (5 or 6 fields, e.g. `0 9 * * MON-FRI`).
`timezone`	`string \| undefined`	`optional` — New IANA timezone (e.g. `Europe/Stockholm`). Affects when the schedule fires.
`missedRunPolicy`	`"skip" \| "fire" \| undefined`	`optional`
`payload`	`Record<string, unknown> \| null \| undefined`	`optional` — Pass null to clear, omit to leave unchanged, or an object to replace.
`enabled`	`boolean \| undefined`	`optional` — Toggle whether the schedule fires.
`runtimeUserId`	`string \| null \| undefined`	`optional` — Override the workspace default service user as the actor recorded on `schedule.fired` events. Null clears the override. Workspace-admin-only to set.