Activepieces Management Octri Preview
POST/v1/flows

Create a flow

Creates a flow in a project, optionally associating it with a folder or template. Supply displayName and projectId; use metadata for additional string-keyed values.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

6 body fields

Flow details. displayName and projectId are required.

displayNamestringrequired
The flow's display name.
folderIdstringoptional
The identifier of the folder to associate with the flow.
folderNamestringoptional
The name of the folder to associate with the flow.
metadataobjectoptional
Additional flow metadata as an object with string property names.
projectIdstringrequired
The unique identifier of the project that will contain the flow.
templateIdstringoptional
The identifier of the template to use for the flow.

1 status code
201Returns the created flow, including its identifier, project and folder associations, status, operation status, version, and timestamps.
createdstringrequired
externalIdstringrequired
folderIdstringoptional
idstringrequired
metadataobjectoptional
operationStatusstringrequired
Allowed:NONEDELETINGENABLINGDISABLING
ownerIdstringoptional
projectIdstringrequired
publishedVersionIdstringoptional
statusstringrequired
Allowed:ENABLEDDISABLED
templateIdstringoptional
timeSavedPerRunnumberoptional
triggerSourceobjectoptional
updatedstringrequired
versionobjectrequired

Error handling

displayName and projectId are required. The projectId must identify the project for the new flow; provide folderId, folderName, metadata, or templateId only when applicable.