Update a job
Change a job’s name, description, code, trigger, or parameters, or archive it.
Only the fields passed are changed. To change part of the script, pass edits: exact replacements of text in the current script. Pass code only to replace the whole script. New code is stored as a new version of the job’s script, so earlier executions keep the version they ran. To create a job, use create_job instead.
Requires an API key with the write scope.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Request
Complete new Python source for the job’s script, stored as a new script version. Declare dependencies inline in a PEP 723 # /// script block. For a change to part of the script, pass edits instead.
Replacements applied in order to the job’s current script, stored as a new script version. Each old_string is matched against the script as left by the edits before it. If any edit fails to match, no change is saved. Cannot be combined with code.
True archives the job, hiding it from the active job list; false restores it.
True creates or replaces the job’s trigger from the trigger fields; false removes it.
What runs the job automatically: file_uploaded runs it on each uploaded file that matches the conditions; job_completed runs it on the output files of another job’s executions; schedule configures a recurring cron schedule. Required when trigger_enabled is true.
Restricts a file_uploaded trigger to files from this instrument.
Filters on the triggering event. For file_uploaded, any of file_name_pattern, file_extensions (list of strings starting with ’.’; files with no extension always pass), source_type, min_size_kb, and max_size_kb (both inclusive). file_name_pattern is a case-sensitive glob in which * matches any characters, including folder separators, ? matches one character, and ’/’ and ” each match either separator. It must match the file’s whole path or the part after any separator, so ‘.csv’ and ‘run_.csv’ match files in any folder. For job_completed, source_job_id (required) and statuses (list drawn from completed and failed; defaults to completed). For schedule, cron (required five-field expression: minute, hour, day of month, month, day of week) and timezone (required IANA timezone, e.g. America/Los_Angeles). Cron supports numbers, month and weekday names, *, ranges, lists, and steps.
draft while the job is still being worked on; in_review once its author considers it ready for an admin to publish; published once it is ready for others to rely on. New jobs start as draft.
Response
Pass this as job_id to the job execution tools.
draft while the job is still being worked on; in_review once its author considers it ready for an admin to publish; published once it is ready for others to rely on. New jobs start as draft.