---
title: "POST /v1/flows"
method: POST
path: "/v1/flows"
tags: ["flows"]
---

# POST /v1/flows

`POST /v1/flows`

Create a flow

## Request body

- object
  - `displayName` string, required
  - `folderId` string
  - `folderName` string
  - `projectId` string, required
  - `templateId` string
  - `metadata` object

## Response `201`

Default Response

- object
  - `id` string, required
  - `created` string, required
  - `updated` string, required
  - `projectId` string, required
  - `externalId` string, required
  - `ownerId` string, nullable
  - `folderId` string, nullable
  - `status` 'ENABLED' | 'DISABLED', required
  - `publishedVersionId` string, nullable
  - `metadata` object, nullable
  - `operationStatus` 'NONE' | 'DELETING' | 'ENABLING' | 'DISABLING', required
  - `timeSavedPerRun` number, nullable
  - `templateId` string, nullable
  - `version` object, required
    - `id` string, required
    - `created` string, required
    - `updated` string, required
    - `flowId` string, required
    - `displayName` string, required
    - `trigger` union, required
      - object
        - `name` string, required
        - `valid` boolean, required
        - `displayName` string, required
        - `nextAction` unknown
        - `lastUpdatedDate` string, required
        - `type` 'PIECE_TRIGGER', required
        - `settings` object, required
          - `sampleData` object
            - `sampleDataFileId` string
            - `sampleDataInputFileId` string
            - `lastTestDate` string
          - `propertySettings` object, required
          - `customLogoUrl` string
          - `pieceName` string, required
          - `pieceVersion` string, required
          - `triggerName` string
          - `input` object, required
      - object
        - `name` string, required
        - `valid` boolean, required
        - `displayName` string, required
        - `nextAction` unknown
        - `lastUpdatedDate` string, required
        - `type` 'EMPTY', required
        - `settings` unknown, required
    - `updatedBy` string, nullable
    - `valid` boolean, required
    - `schemaVersion` string, nullable
    - `agentIds` string[], required
    - `state` 'LOCKED' | 'DRAFT', required
    - `connectionIds` string[], required
    - `backupFiles` object, nullable
    - `notes` object[], required
      - `id` string, required
      - `content` string, required
      - `ownerId` string, nullable
      - `color` 'orange' | 'red' | 'green' | 'blue' | 'purple' | 'yellow', required
      - `position` object, required
        - `x` number, required
        - `y` number, required
      - `size` object, required
        - `width` number, required
        - `height` number, required
      - `createdAt` string, required
      - `updatedAt` string, required
  - `triggerSource` object
    - `schedule` object, nullable
      - `type` 'CRON_EXPRESSION', required
      - `cronExpression` string, required
      - `timezone` string, required

---

[API](https://skmtc.dev/activepieces/apis/activepieces-documentation.md) · [All operations](https://skmtc.dev/activepieces/apis/activepieces-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/activepieces/activepieces-documentation/revisions/745e4b7f764a/schema)