Skip to content

WorkflowClient.update

python
def WorkflowClient.update(
    workflow_or_slug: Workflow | str,
    name: str | None = None,
    description: str | None = None,
) -> Workflow

Update a workflow.

Parameters

workflow_or_slug Workflow | str required

The workflow or workflow slug to update.

name str | None

Optional new display name for the workflow. If omitted, the display name is unchanged.

description str | None

Optional new workflow description. Pass an empty string to clear the description. If omitted, the description is unchanged.

Returns

The updated workflow object.

Type to search…