Skip to main content
PUT
Schedule update.

Authorizations

Authorization
string
header
required

Bearer JWT token or API Key (sk-*).

Path Parameters

scheduleId
string
required

Body

application/json
name
string

Provide name of result resource and automation itself.

category
string

Category.

desc
string

Description.

metadata
object

Replacement resource metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use.

cron
string

5-field cron expression used by the scheduling system.

Example:

"30 9 * * MON-FRI"

targetType
enum<string>

Optional normalized execution target type. Must be sent together with targetId when changing the target.

Available options:
JOB_TEMPLATE,
AGENT,
PLATFORM_OPERATION
targetId
string

Optional normalized execution target id aligned with targetType.

targetVersion
number

Optional reserved target version metadata. Ignored for AGENT targets, which always execute the current Agent definition.

targetConfig
object

Optional normalized target configuration payload reserved for future target-specific execution settings.

timezone
string

IANA timezone for this schedule. Use canonical names like Europe/Warsaw or UTC. Abbreviations like CET or EST are rejected because they break DST handling.

Example:

"Europe/Warsaw"

Response

OK.

Last modified on September 5, 2026