Update Schedule - BlobHub

Update attributes of an existing schedule. Only fields supplied in the request are changed; omitted fields keep their current values. A schedule in the completed state cannot be updated.

POST `/revisions/:id/data/command` (Command: `update_schedule`)

Request Body

Parameter	Type	Required	Description
`command`	string	Yes	Must be `update_schedule`.
`schedule_id`	string	Yes	Id or alias of the schedule to update.
`alias`	string	No	Optional new alias for the schedule. 6–42 chars, lowercase (`a`–`z`, `0`–`9`, `_`, `-`), unique in the revision.
`description`	string	No	New description, at most 256 characters. Every later fire sends it as the execution’s `description`.
`enabled`	boolean	No	New enabled flag.
`repeat`	string	No	Either `one_time` or `recurring_cron`.
`cron_expression`	string	No	Six-field AWS cron expression. Must be set when repeat is `recurring_cron`.
`invocation_time`	string	No	ISO 8601 datetime. Must be set when repeat is `one_time`.
`timezone`	string	No	IANA timezone name.
`start_date`	string	No	ISO 8601 UTC datetime.
`end_date`	string	No	ISO 8601 UTC datetime.
`invocation_target_type`	string	No	Must be `workflow`.
`invocation_target`	object	No	Replacement invocation target object — `target`, `workflow` and `input_data`; see Invocation Targets. Re-checked and, if pinned, re-resolved whenever supplied, even to an otherwise-identical value.

An absent description means “leave unchanged”; a description present with an empty value does not. "description": "" is a write that clears it — get_schedule and list_schedules then return no description key.

If repeat is changed to recurring_cron, cron_expression must be supplied in the same request. If changed to one_time, invocation_time must be supplied. invocation_time follows the same naive-datetime format as on create.

See Alias Grammar for the character rules, length limits, and the id-shape restriction — an alias may not be shaped like a UUID.

Response

Parameter	Type	Description
`schedule`	object	The updated schedule object.

Errors

Status	Error	Cause
400	`invalid_request_body`	An alias outside the grammar, an unknown field — at the top level, in `invocation_target` or in its `target` — a `target` part that is blank or over 64 characters, a `description` over 256 characters, or a following target (`target.revision` is `default`) naming its `session` by id.
403	`forbidden`	The schedule does not exist, or it is not reachable from this revision.
400	`alias_in_use`	The alias is already taken in this revision.
400	`schedule_completed`	A schedule in the `completed` state cannot be updated.
400	`invalid_invocation_target`	`target.blob` is an alias with no `target.org`, or `workflow.definition` is an id where the definition follows `default`.
400	`invalid_workflow_reference`	A malformed `workflow`.
400	`invalid_definition_category`	A supplied `workflow.definition` is a definition id naming a `playground` definition the caller can reach.
403	`forbidden`	Any failure to resolve or reach a supplied target (`target.org`, `target.blob`, `target.revision`, `target.session`) or its `workflow` source — identical whatever the cause.

A caller cannot tell the schedule’s two 403 cases apart — a schedule that does not exist and one that is not reachable both answer forbidden. Sessions already work this way; see Close Session.

Example

{
  "command": "update_schedule",
  "schedule_id": "sched-001",
  "enabled": false,
  "timezone": "Europe/London"
}

{
  "status": "success",
  "schedule": {
    "id": "sched-001",
    "alias": "morning-digest",
    "description": "Daily report for the morning digest.",
    "revision_id": "rev-scheduler-001",
    "created_at": "2026-04-07T12:00:00Z",
    "modified_at": "2026-04-07T13:15:00Z",
    "auth_target": "user",
    "auth_target_id": "user-001",
    "enabled": false,
    "repeat": "recurring_cron",
    "cron_expression": "0 9 * * ? *",
    "invocation_time": null,
    "timezone": "Europe/London",
    "start_date": null,
    "end_date": null,
    "state": "active",
    "invocation_target_type": "workflow",
    "invocation_target": {
      "target": {
        "blob": "5b0e7c2a-3f61-4d9b-8a47-2c9e1f6d0b38",
        "revision": "default",
        "session": "scheduled_runs"
      },
      "workflow": {"definition": "daily-report"},
      "input_data": []
    }
  }
}