Workflows

Update Workflow

Changed on

Update an existing workflow.

Path Parameters: - workflow_id: UUID of the workflow

Request Body: - name: Optional new name - description: Optional new description - nodes: Optional new nodes - edges: Optional new edges - is_active: Optional active status - is_template: Optional template status - metadata_json: Optional metadata

Returns: Updated workflow

put/api/workflows/{workflow_id}

Request

  • Base URL
    https://api.qomplement.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.qomplement.com/api/workflows/{workflow_id}
  • Auth
    HTTP bearer

Path parameters

workflow_idstring required

Query parameters

organization_idstring nullable

Request body

namestring nullable
descriptionstring nullable
is_activeboolean nullable
is_templateboolean nullable
metadata_jsonobject nullable
project_idstring nullable

Response

Successful Response

idstring required
user_idstring required
namestring required
descriptionstring nullable required
workflow_typestring required
nodesobject[] required
edgesobject[] required
is_activeboolean required
is_templateboolean required
last_executed_atstring nullable required
last_execution_statusstring nullable required
execution_countinteger required
created_atstring required
updated_atstring required
metadata_jsonobject required
project_idstring nullable
has_dashboardboolean

Changes

    • info

      added the new optional query request parameter organization_id

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status