Workflows.Update

func (workflowClient) Update(
    ctx context.Context,
    slug string,
    options ...workflow.UpdateOption,
) (*workflows.Workflow, error)

Copy

Update a workflow.

Parameters

slug string required

The workflow slug.

workflow.WithName(name string) workflow.UpdateOption

Optional new display name for the workflow.

workflow.WithDescription(description string) workflow.UpdateOption

Optional new workflow description. Pass an empty string to clear the description.

Returns

The updated workflow object.

Request example

Go

updatedWorkflow, err := client.Workflows.Update(ctx,
    "scene-processing",
    workflow.WithName("Scene processing"),
    workflow.WithDescription("Process new scenes into analysis-ready outputs."),
)

Copy

Errors

not_found workflow not found

The specified workflow does not exist.