UpdateWorkflowBody

Request body for updating a Workflow.

Definition

TypeScript

interface UpdateWorkflowBody {
  name?: string | undefined;
  description?: string | undefined;
  entryNodeId?: string | null | undefined;
  outputNodeId?: string | null | undefined;
  inputSchema?: Record<string, unknown> | undefined;
  outputSchema?: Record<string, unknown> | undefined;
  runtimeUserId?: string | null | undefined;
}

Fields

Field	Type	Notes
`name`	`string \| undefined`	`optional` — New name
`description`	`string \| undefined`	`optional` — New description
`entryNodeId`	`string \| null \| undefined`	`optional` — Entry node ID
`outputNodeId`	`string \| null \| undefined`	`optional` — Node whose output becomes the workflow's return value. Must reference a node in this workflow.
`inputSchema`	`Record<string, unknown> \| undefined`	`optional` — Zod-shaped input schema.
`outputSchema`	`Record<string, unknown> \| undefined`	`optional` — Zod-shaped output schema.
`runtimeUserId`	`string \| null \| undefined`	`optional` — Override the workspace default service user as the runtime caller when this workflow runs headlessly. Null clears the override. Workspace-admin-only to set.