Skip to content

Workflows.Update

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

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.

Errors

not_found workflow not found

The specified workflow does not exist.

Type to search…