Update Workflow
update-workflowUpdate only supplied fields of an existing workflow; at least one changed field is required. Omitted fields remain unchanged. Set schedule.enabled=false to pause or schedule.enabled=true to resume; set schedule.cron to change the cadence.
Instructions
Update only supplied fields of an existing workflow; at least one changed field is required. Omitted fields remain unchanged. Set schedule.enabled=false to pause or schedule.enabled=true to resume; set schedule.cron to change the cadence. Supplying sinks replaces the whole list and may remove delivery targets. Read get-workflow before editing sinks so you can preserve their IDs. Already buffered deliveries can continue after pausing. Returns the workflow object: id, name, description, query, schedule, revision, created_at, updated_at, and sinks. The query object contains database and sql. schedule is null for manual-only workflows; otherwise it contains cron, enabled, and next_run_at (null while paused). Each sink has id, type, and settings. HTTP settings contain url (null when unreadable), url_configured, and header_names; header values are never returned. Table settings contain database and table. Requires an admin API key bound to the selected organization and cluster, or OAuth. Organization members may read; organization admins may create, update, or delete. Workflows execute with organization credentials and continue after the creating key is revoked or expires.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Workflow ID returned by list-workflows, get-workflow, or create-workflow. | |
| name | No | ||
| query | No | Omit to preserve the query. Omitted database or sql fields retain their saved values. | |
| sinks | No | Replaces the entire list. Omit to preserve it; [] removes all. Preserve IDs when editing. Existing HTTP sinks may omit settings, settings.url, or settings.headers to retain them. Within a supplied settings.headers map, null preserves a stored value; omitted header names are removed. | |
| cluster | Yes | RawTree cluster to use for this operation. | |
| schedule | No | Omit to preserve the schedule; null makes the workflow manual-only. Omitted cron or enabled keep their saved values. cron is required when scheduling a manual-only workflow. | |
| description | No | Omit to preserve the description; null or blank clears it. | |
| organization | Yes | RawTree organization containing the target cluster. |