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

# POST /v1/flows/{id}

`POST /v1/flows/{id}`

Apply an operation to a flow

## Path parameters

- `id` string, required

## Request body

- union
  - object — Move Action
    - `type` 'MOVE_ACTION', required
    - `request` object, required
      - `name` string, required
      - `newParentStep` string, required
      - `stepLocationRelativeToNewParent` 'AFTER' | 'INSIDE_LOOP' | 'INSIDE_BRANCH'
      - `branchIndex` number
  - object — Change Status
    - `type` 'CHANGE_STATUS', required
    - `request` object, required
      - `status` 'ENABLED' | 'DISABLED', required
  - object — Lock and Publish
    - `type` 'LOCK_AND_PUBLISH', required
    - `request` object, required
      - `status` 'ENABLED' | 'DISABLED'
  - object — Copy as Draft
    - `type` 'USE_AS_DRAFT', required
    - `request` object, required
      - `versionId` string, required
  - object — Lock Flow
    - `type` 'LOCK_FLOW', required
    - `request` object, required
  - object — Import Flow
    - `type` 'IMPORT_FLOW', required
    - `request` object, 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
              - …
            - `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
      - `schemaVersion` string, nullable
      - `notes` object[], nullable
        - `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
  - object — Change Name
    - `type` 'CHANGE_NAME', required
    - `request` object, required
      - `displayName` string, required
  - object — Delete Action
    - `type` 'DELETE_ACTION', required
    - `request` object, required
      - `names` string[], required
  - object — Update Action
    - `type` 'UPDATE_ACTION', required
    - `request` union, required
      - object
        - `name` string, required
        - `valid` boolean, required
        - `displayName` string, required
        - `skip` boolean
        - `type` 'CODE', required
        - `settings` object, required
          - `customLogoUrl` string
          - `sourceCode` object, required
            - `packageJson` string, required
            - `code` string, required
          - `input` object, required
          - `errorHandlingOptions` object
            - `continueOnFailure` object
              - …
            - `retryOnFailure` object
              - …
      - object
        - `name` string, required
        - `valid` boolean, required
        - `displayName` string, required
        - `skip` boolean
        - `type` 'LOOP_ON_ITEMS', required
        - `settings` object, required
          - `customLogoUrl` string
          - `items` string, required
      - object
        - `name` string, required
        - `valid` boolean, required
        - `displayName` string, required
        - `skip` boolean
        - `type` 'PIECE', required
        - `settings` object, required
          - `customLogoUrl` string
          - `propertySettings` object, required
          - `pieceName` string, required
          - `pieceVersion` string, required
          - `actionName` string
          - `input` object, required
          - `errorHandlingOptions` object
            - `continueOnFailure` object
              - …
            - `retryOnFailure` object
              - …
      - object
        - `name` string, required
        - `valid` boolean, required
        - `displayName` string, required
        - `skip` boolean
        - `type` 'ROUTER', required
        - `settings` object, required
          - `customLogoUrl` string
          - `branches` union[], required
            - union
              - …
          - `executionType` 'EXECUTE_ALL_MATCH' | 'EXECUTE_FIRST_MATCH', required
  - object — Add Action
    - `type` 'ADD_ACTION', required
    - `request` object, required
      - `parentStep` string, required
      - `stepLocationRelativeToParent` 'AFTER' | 'INSIDE_LOOP' | 'INSIDE_BRANCH'
      - `branchIndex` number
      - `action` union, required
        - object
          - `name` string, required
          - `valid` boolean, required
          - `displayName` string, required
          - `skip` boolean
          - `type` 'CODE', required
          - `settings` object, required
            - `customLogoUrl` string
            - `sourceCode` object, required
              - …
            - `input` object, required
            - `errorHandlingOptions` object
              - …
        - object
          - `name` string, required
          - `valid` boolean, required
          - `displayName` string, required
          - `skip` boolean
          - `type` 'LOOP_ON_ITEMS', required
          - `settings` object, required
            - `customLogoUrl` string
            - `items` string, required
        - object
          - `name` string, required
          - `valid` boolean, required
          - `displayName` string, required
          - `skip` boolean
          - `type` 'PIECE', required
          - `settings` object, required
            - `customLogoUrl` string
            - `propertySettings` object, required
            - `pieceName` string, required
            - `pieceVersion` string, required
            - `actionName` string
            - `input` object, required
            - `errorHandlingOptions` object
              - …
        - object
          - `name` string, required
          - `valid` boolean, required
          - `displayName` string, required
          - `skip` boolean
          - `type` 'ROUTER', required
          - `settings` object, required
            - `customLogoUrl` string
            - `branches` union[], required
              - …
            - `executionType` 'EXECUTE_ALL_MATCH' | 'EXECUTE_FIRST_MATCH', required
  - object — Update Trigger
    - `type` 'UPDATE_TRIGGER', required
    - `request` union, required
      - object
        - `name` string, required
        - `valid` boolean, required
        - `displayName` string, required
        - `nextAction` unknown
        - `type` 'EMPTY', required
        - `settings` unknown, required
      - object
        - `name` string, required
        - `valid` boolean, required
        - `displayName` string, required
        - `nextAction` unknown
        - `type` 'PIECE_TRIGGER', required
        - `settings` object, required
          - `propertySettings` object, required
          - `customLogoUrl` string
          - `pieceName` string, required
          - `pieceVersion` string, required
          - `triggerName` string
          - `input` object, required
  - object — Change Folder
    - `type` 'CHANGE_FOLDER', required
    - `request` object, required
      - `folderId` string, nullable
  - object — Duplicate Action
    - `type` 'DUPLICATE_ACTION', required
    - `request` object, required
      - `stepName` string, required
  - object — Delete Branch
    - `type` 'DELETE_BRANCH', required
    - `request` object, required
      - `branchIndex` number, required
      - `stepName` string, required
  - object — Add Branch
    - `type` 'ADD_BRANCH', required
    - `request` object, required
      - `branchIndex` number, required
      - `stepName` string, required
      - `conditions` array[]
        - union[]
          - union
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
      - `branchName` string, required
  - object — Duplicate Branch
    - `type` 'DUPLICATE_BRANCH', required
    - `request` object, required
      - `branchIndex` number, required
      - `stepName` string, required
  - object — Skip Action
    - `type` 'SET_SKIP_ACTION', required
    - `request` object, required
      - `names` string[], required
      - `skip` boolean, required
  - object — Update Metadata
    - `type` 'UPDATE_METADATA', required
    - `request` object, required
      - `metadata` object, nullable
  - object
    - `type` 'MOVE_BRANCH', required
    - `request` object, required
      - `sourceBranchIndex` number, required
      - `targetBranchIndex` number, required
      - `stepName` string, required
  - object
    - `type` 'SAVE_SAMPLE_DATA', required
    - `request` object, required
      - `stepName` string, required
      - `payload` unknown, required
      - `type` 'INPUT' | 'OUTPUT', required
  - object — Update Minutes Saved
    - `type` 'UPDATE_MINUTES_SAVED', required
    - `request` object, required
      - `timeSavedPerRun` number, nullable
  - object — Update Owner
    - `type` 'UPDATE_OWNER', required
    - `request` object, required
      - `ownerId` string, required
  - object — Update Note
    - `type` 'UPDATE_NOTE', required
    - `request` 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
  - object — Delete Note
    - `type` 'DELETE_NOTE', required
    - `request` object, required
      - `id` string, required
  - object — Add Note
    - `type` 'ADD_NOTE', required
    - `request` object, required
      - `id` string, required
      - `content` string, required
      - `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
  - object — Update Sample Data Info
    - `type` 'UPDATE_SAMPLE_DATA_INFO', required
    - `request` object, required
      - `stepName` string, required
      - `sampleDataSettings` object, nullable
        - `sampleDataFileId` string
        - `sampleDataInputFileId` string

## Response `200`

Default Response

---

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