Workflows v2 (Plays) / TypeScript SDK
Update workflow
Update an existing workflow. Pass any subset of name, description, workflow_definition, or status. workflow_definition is the full DAG object (nodes + edges + variables) - typically produced by compile-workflow-from-prompt. Returns the updated workflow record.
pipeline.updateWorkflowDeterministic operationParameters
workspaceIdOptional · string- Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.
workflowIdRequired · string- Workflow UUID to update.
nameOptional · string- See the input schema for this field.
descriptionOptional · string- See the input schema for this field.
workflow_definitionOptional · object- Full WorkflowDefinition DAG. Typically supplied verbatim from the compile-workflow-from-prompt response.
statusOptional · string- Optional status transition.draft · active · paused · archived
await pipeline.updateWorkflow({
"workflowId": "00000000-0000-4000-8000-000000000000"
})Full input schema
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"minLength": 1,
"description": "Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client."
},
"workflowId": {
"type": "string",
"description": "Workflow UUID to update."
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"workflow_definition": {
"type": "object",
"additionalProperties": true,
"description": "Full WorkflowDefinition DAG. Typically supplied verbatim from the compile-workflow-from-prompt response."
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived"
],
"description": "Optional status transition."
}
},
"required": [
"workflowId"
]
}