---
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

## Response `201`

Default Response

- object
  - `id` string, required
  - `created` string, required
  - `updated` string, required
  - `projectId` string, required
  - `externalId` string, nullable
  - `folderId` string, nullable
  - `status` union, required
    - 'ENABLED'
    - 'DISABLED'
  - `schedule` object, nullable
    - `type` 'CRON_EXPRESSION', required
    - `cronExpression` string, required
    - `timezone` string, required
    - `failureCount` number
  - `publishedVersionId` 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
        - `type` 'PIECE_TRIGGER', required
        - `settings` object, required
          - `pieceName` string, required
          - `pieceVersion` string, required
          - `pieceType` union, required
            - 'CUSTOM'
            - 'OFFICIAL'
          - `packageType` union, required
            - 'ARCHIVE'
            - 'REGISTRY'
          - `triggerName` string
          - `input` object, required
          - `inputUiInfo` object, required
            - `sampleDataFileId` string
            - `lastTestDate` string
            - `customizedInputs` object
            - `currentSelectedData` unknown
      - object
        - `name` string, required
        - `valid` boolean, required
        - `displayName` string, required
        - `nextAction` unknown
        - `type` 'EMPTY', required
        - `settings` unknown, required
    - `updatedBy` string, nullable
    - `valid` boolean, required
    - `schemaVersion` string, nullable
    - `state` union, required
      - 'LOCKED'
      - 'DRAFT'

## Changes

- **2025-01-09** `b6ee827ed6ef` — 1 info
  - added the new optional request property `folderId`
- **2024-12-31** `3c05b427e5b5` — 1 info
  - added the optional property `externalId` to the response with the `201` status
- **2024-11-12** `499ae054e9e9` — 2 info
  - added the optional property `version/schemaVersion` to the response with the `201` status
  - added the optional property `version/trigger/anyOf[subschema #1]/settings/inputUiInfo/sampleDataFileId` to the response with the `201` status
- **2024-09-13** `225ff954244e` — 1 breaking, 1 info
  - api path removed without deprecation
  - endpoint added
- **2024-09-03** `b95c8c8e8262` — 1 breaking
  - the response property `version/trigger/anyOf[subschema #1]/settings/triggerName` became optional for the status `201`

[Full history](https://skmtc.dev/activeboxes/apis/activeboxes-documentation/changes/v1/flows/post.md)

---

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