Workflow

Update Workflow

Update a workflow's name, description, or block definition. Creates the workflow if it doesn't exist.

post/workflows/update_workflow

Query parameters

workflow_idstring required

x-api-keystring nullable

workflow_namestring nullable

New workflow name.

workflow_descriptionstring nullable

New workflow description.

Successful Response

idstring required

Workflow identifier.

user_uuidstring nullable

User who created the workflow.

org_idstring nullable

Organization that owns the workflow.

namestring required

Workflow name.

descriptionstring nullable

Workflow description.

statusstring required

Lifecycle status of the workflow definition (e.g. draft, ready).

stepstring required

Current authoring step in the builder UI.

created_atstring date-time required

Timestamp when the record was created.

updated_atstring date-time required

Timestamp when the record was last updated.

last_run_datestring date-time nullable

Timestamp of the most recent run.