Operating system set to macOS
Documentation jurisdiction set to United States
Sign inConnect Claude

Update Job Definition Api V1 Workstreams Jobs Job Id Patch

patch/api/v1/workstreams/jobs/{job_id}

Update job definition

Update a job definition (by ID or permakey).

Path parameters

job_idrequired
path
β€”

Request bodyapplication/json

FieldTypeDescription
namestring | nullβ€”
descriptionstring | nullβ€”
goal_templatestring | nullβ€”
toolsstring[] | nullβ€”
deliverablesobject[] | nullβ€”
max_turnsinteger | nullβ€”
max_cost_usdnumber | nullβ€”
max_duration_minutesinteger | nullβ€”
target_selectorTargetSelector | nullβ€”
per_client_overridesobject | nullβ€”
default_contextobject | nullβ€”
source_tracingboolean | nullβ€”
human_checkpointsstring[] | nullβ€”
schedulestring | nullβ€”
schedule_timezonestring | nullβ€”
is_enabledboolean | nullβ€”
statusstring | nullβ€”

Responses

200Successful Response
FieldTypeDescription
idrequiredstring (uuid)β€”
permakeystring | nullStable human-readable key for the batch/fan-out deep-link URL /workstreams/{ws}/cycles/{permakey}/… (#173). Null on legacy rows.
namerequiredstringβ€”
descriptionstring | nullβ€”
domainrequiredstringβ€”
goal_templaterequiredstringβ€”
toolsrequiredstring[]β€”
deliverablesrequiredobject[]β€”
item shape
Empty object.
max_turnsrequiredintegerβ€”
max_cost_usdrequirednumberβ€”
max_duration_minutesrequiredintegerβ€”
target_selectorrequiredobjectβ€”
show nested
Empty object.
per_client_overridesrequiredobjectβ€”
show nested
Empty object.
default_contextrequiredobjectβ€”
show nested
Empty object.
source_tracingrequiredbooleanβ€”
human_checkpointsrequiredstring[]β€”
schedulestring | nullβ€”
schedule_timezonerequiredstringβ€”
is_enabledrequiredbooleanβ€”
next_run_atany | nullβ€”
last_run_atany | nullβ€”
statusrequiredstringβ€”
created_byrequiredstringβ€”
created_atrequiredanyβ€”
updated_atrequiredanyβ€”
current_versioninteger | nullLatest version number in job_definition_version; null if no history yet.
422Validation Error
FieldTypeDescription
detailValidationError[]β€”
item shape
curl https://api.dev.arch.ie/api/v1/workstreams/jobs/<job_id> \
  -X PATCH \
  -H "Authorization: Bearer sk_..." \
  -H "Content-Type: application/json" \
  -d '{
       "name": null,
       "description": null,
       "goal_template": null,
       "tools": null,
       "deliverables": null,
       "max_turns": null,
       "max_cost_usd": null,
       "max_duration_minutes": null,
       "target_selector": null,
       "per_client_overrides": null,
       "default_context": null,
       "source_tracing": null,
       "human_checkpoints": null,
       "schedule": null,
       "schedule_timezone": null,
       "is_enabled": null,
       "status": null
     }'
API Reference Β· Archie for developers