Skip to main content
PATCH
Patch a schedule

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
required

The unique identifier of the schedule.

Body

application/json
enabled
boolean | null

Whether the schedule is active.

Response

The schedule was updated.

id
string
required

The unique identifier of the schedule.

account_id
string
required

The linked account this schedule syncs.

action_id
string
required

The action this schedule runs.

name
string
required

The human-readable name of the schedule.

sync_params
object
required

The parameters the action is called with on each run.

params_hash
string
required

A hash of sync_params, distinguishing schedules for the same action.

enabled
boolean
required

Whether the schedule is currently active.

cadence
string
required

How often the sync fires. ISO 8601 duration. Read-only: on auto_link schedules it comes from the sync config.

last_run_is_failure
boolean
required

Whether the most recent run failed; false before its first run.

created_at
string<date-time>
required

When the schedule was created.

updated_at
string<date-time>
required

When the schedule was last updated.

sync_config_id
string | null

The sync config that bounds this schedule. Set on every schedule, hand-authored ones included — it is what permits the action to sync at all. Use source to tell how a schedule came to exist; null here means only that the schedule predates the field.

source
enum<string> | null

How the schedule came to exist: auto_link if its sync config fanned it out, manual if it was hand-authored. This is the discriminator between the two, not sync_config_id.

Available options:
auto_link,
manual,
unmapped_value,
null
full_sync_after
string | null

The point after which an incremental sync falls back to a full sync. ISO 8601 duration; null when unset. Read-only: on auto_link schedules it comes from the sync config.

start_at
string<date-time> | null

When the schedule was first scheduled to fire; null when unset. Read-only: on auto_link schedules it comes from the sync config.

next_run_at
string<date-time> | null

When the schedule will next fire; null when unset.

last_run_at
string<date-time> | null

When the most recent run completed; null until one has. A fire refused before syncing (invalid_config, quota_exceeded) sets last_run_status but not this.

last_run_status
string | null

The status of the most recent run; null before its first run.

last_run_error
string | null

Why the most recent run failed or stopped early.

paused_reason
string | null

Why the schedule is not currently running even though enabled may be true. sync_config_disabled while its sync config is disabled or has been removed, action_disabled while the action is switched off on the connector profile, action_not_syncable while the connector version the profile is on no longer supports data sync for the action, auto_link_disabled while auto_link is off on a schedule that auto_link created (hand-authored schedules are unaffected by it), or an account-lifecycle reason such as the linked account being disabled. Only the widest cause currently holding the schedule back is reported, so clearing it may reveal another. The schedule keeps its own enabled value throughout. null means nothing is holding it back.