OpenAPI 3.0.32026-08-1117137122.8 KB

fb2fd1bf56e5

flows

putFlow

Update automation flow by id

put/v1/automation/flows/{flow_id}

Path parameters

flow_idstring required

ID of the Automation Flow

Example:7791b04a-16d2-44a2-9af9-2d59c25c512f

Automation Workflow ID

Request body

idstring

ID of the Automation Flow

flow_namestring required

A descriptive name for the Automation

enabledboolean

Whether the automation is enabled or not

entity_schemastring

The triggering entity schema

runsnumber

Number of automation executions that ran

created_atstring date-time

updated_atstring date-time

created_bystring

User / service who created automation flow

last_updated_bystring

User / service who last updated automation flow

org_idstring

Organization the automation flow belongs to

system_flowboolean

Determines if the flow is a system generated flow

versionnumber

Version of the flow

_manifeststring[] nullable

Source blueprint/manifest ID used when automation is created via blueprints.

protectedboolean

If true, automation is displayed in read-only mode in the UI to discourage changes

Response

The updated automation flow

idstring

ID of the Automation Flow

flow_namestring required

A descriptive name for the Automation

enabledboolean

Whether the automation is enabled or not

entity_schemastring

The triggering entity schema

runsnumber

Number of automation executions that ran

created_atstring date-time

updated_atstring date-time

created_bystring

User / service who created automation flow

last_updated_bystring

User / service who last updated automation flow

org_idstring

Organization the automation flow belongs to

system_flowboolean

Determines if the flow is a system generated flow

versionnumber

Version of the flow

_manifeststring[] nullable

Source blueprint/manifest ID used when automation is created via blueprints.

protectedboolean

If true, automation is displayed in read-only mode in the UI to discourage changes