Effects
- Creates a new integration flow with a unique ID
- Copies all configuration settings from the source flow
- Sets the initial status to
SCHEDULED
- Maintains the same steps and variable definitions
- Creates fresh execution history
Common Use Cases
- Creating test versions of production flows
- Setting up similar flows for different environments
- Backup before major changes
- Template-based flow creation
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
ID of the integration template (or existing flow) to clone.
Body
Data for the new cloned flow.
Data required to clone an integration or webhook template.
The desired name for the new cloned flow.
Tag for the new cloned flow.
Category for the new cloned flow.
Optional dynamic variables (key-value pairs) to override in the cloned flow.
Response
Integration flow cloned successfully.
Represents an integration flow.
Unique identifier for the flow
"123e4567-e89b-12d3-a456-426614174000"
ID of the user who created the flow
"123e4567-e89b-12d3-a456-426614174001"
ID of the company who created the flow
"123e4567-e89b-12d3-a456-426614174001"
ID of the workspace the flow belongs to. Defaults to "default" if not specified.
"default"
Name of the flow
"VTIGER BRING CONTACTS"
Logo of the the flow
Retry delay in specified units
5
Unit of retry delay
seconds
, minutes
, hours
, days
Maximum number of retries
3
Current status of the flow
scheduled
, in-progress
, running
, failed
, stopped
, deleted
Timestamp when the flow was created
"2023-10-01T12:34:56Z"
Timestamp when the flow was last updated
"2023-10-02T12:34:56Z"
List of executions associated with the flow
List of steps associated with the flow
Indicates if the flow is a template
false
Direction of the flow
inbound
, outbound
Flow mapping configuration (any JSON object structure)
Tag of the flow
"lead1"
Category of the flow
"all leads"
Timestamp when the flow was deleted
"2023-10-03T12:34:56Z"
Predefined variables for the flow
Variables used in flow steps