Operating system set to macOS
Documentation jurisdiction set to United States
Sign inConnect Claude
API/schemas
Schema

WorkplanUpdate

Request to update a workplan. OpenAPI title is ``WorkplanUpdate``; the Python class name stays ``BlueprintUpdate``.

FieldTypeDescription
namestring | nullWorkplan name
descriptionstring | nullWorkplan description
client_idstring (uuid) | nullClient UUID (references platform.clients). Omit to leave unchanged; send an explicit null to clear the assignment (the handler distinguishes the two via fields-set).
config_overridesobject | nullConfiguration overrides — shallow-merged into the stored configuration (existing keys survive unless explicitly overridden).
schedulestring | nullCron schedule expression (folded into configuration; null = unscheduled)
schedule_timezonestring | nullIANA timezone for the schedule (folded into configuration)
max_duration_minutesinteger | nullPer-instance duration guardrail in minutes (folded into configuration). Positive and ≤ 1440 (24h).
human_checkpointsany[] | nullSign-off gate checkpoints (folded into configuration); [] clears the gate
run_modestring | nullRun posture / autonomy: propose|auto_run (folded into configuration)
default_contextobject | nullRun-context bag. Its ``autonomy`` key is an alias for ``run_mode`` (propose|auto_run) — supplied here it is folded into the effective run posture when ``run_mode`` is not given explicitly.
status"draft" | "active" | "paused" | "archived" | nullWorkplan status