jobs

Update metadata on an existing scheduled job: enabled, kill switch, expires_at, params, schedule, and timezone.

Update metadata on an existing scheduled job: enabled, kill switch, expires_at, params, schedule, and timezone. Package-owned jobs keep source in the package repo, so name, code, and published source cannot change here — edit the package and publish. Recurring schedules belong on a package (kody.jobs); deferred one-shots use workflows.create.

Org permission: job:write.

patch/v1/jobs/{id}

Request

  • Base URL: https://api.kody.codes
  • URL: https://api.kody.codes/v1/jobs/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Existing job id from jobList or jobGet output.

Request body

nameunknown
paramsobject nullable

Optional replacement params object passed as the first argument to the job entrypoint. Pass null to clear existing params.

timezonestring nullable

Optional timezone label for cron display and schedule calculation. Pass null to reset to UTC.

enabledboolean

Enable or disable the job without deleting it.

kill_switch_enabledboolean

Force the job off regardless of schedule. This remains visible in jobList and jobGet for debugging.

expires_atstring nullable

Optional UTC ISO timestamp after which the platform stops scheduling this job and auto-disables it (enabled=false). Pass null to clear.

codeunknown

Response

Success.

job_idstring required
namestring required
source_idstring required
published_commitstring nullable required
storage_idstring required
paramsobject
schedule_summarystring required
timezonestring required
enabledboolean required
kill_switch_enabledboolean required
expires_atstring nullable required
expiredboolean required
created_atstring required
updated_atstring required
last_run_atstring
last_run_status'success' | 'error'
last_run_errorstring
last_duration_msinteger
next_run_atstring required
run_countinteger required
success_countinteger required
error_countinteger required
enablement_hintstring nullable required

When the job is enabled but has no on enablement (or only paused ones), an agent-directed message that includes the exact enablementEnable call. Null when the job is off or already has an on enablement.

Changes

No recorded changes to this operation across all 1 revision of this API.