---
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
    - `type` 'MOVE_ACTION', required
    - `request` object, required
      - `name` string, required
      - `newParentStep` string, required
      - `stepLocationRelativeToNewParent` union
        - 'INSIDE_TRUE_BRANCH'
        - 'INSIDE_FALSE_BRANCH'
        - 'AFTER'
        - 'INSIDE_LOOP'
  - object
    - `type` 'CHANGE_STATUS', required
    - `request` object, required
      - `status` union, required
        - 'ENABLED'
        - 'DISABLED'
  - object
    - `type` 'LOCK_AND_PUBLISH', required
    - `request` object, required
  - object
    - `type` 'USE_AS_DRAFT', required
    - `request` object, required
      - `versionId` string, required
  - object
    - `type` 'LOCK_FLOW', required
    - `request` object, required
  - object
    - `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
          - `type` 'PIECE_TRIGGER', required
          - `settings` object, required
            - `pieceName` string, required
            - `pieceVersion` string, required
            - `pieceType` union, required
              - …
            - `packageType` union, required
              - …
            - `triggerName` string
            - `input` object, required
            - `inputUiInfo` object, required
              - …
        - object
          - `name` string, required
          - `valid` boolean, required
          - `displayName` string, required
          - `nextAction` unknown
          - `type` 'EMPTY', required
          - `settings` unknown, required
  - object
    - `type` 'CHANGE_NAME', required
    - `request` object, required
      - `displayName` string, required
  - object
    - `type` 'DELETE_ACTION', required
    - `request` object, required
      - `name` string, required
  - object
    - `type` 'UPDATE_ACTION', required
    - `request` union, required
      - object
        - `name` string, required
        - `valid` boolean, required
        - `displayName` string, required
        - `type` 'CODE', required
        - `settings` object, required
          - `sourceCode` object, required
            - `packageJson` string, required
            - `code` string, required
          - `input` object, required
          - `inputUiInfo` object
            - `currentSelectedData` unknown
            - `customizedInputs` object
            - `lastTestDate` string
          - `errorHandlingOptions` object
            - `continueOnFailure` object
              - …
            - `retryOnFailure` object
              - …
      - object
        - `name` string, required
        - `valid` boolean, required
        - `displayName` string, required
        - `type` 'LOOP_ON_ITEMS', required
        - `settings` object, required
          - `items` string, required
          - `inputUiInfo` object, required
            - `currentSelectedData` unknown
            - `customizedInputs` object
            - `lastTestDate` string
      - object
        - `name` string, required
        - `valid` boolean, required
        - `displayName` string, required
        - `type` 'PIECE', required
        - `settings` object, required
          - `packageType` union, required
            - 'ARCHIVE'
            - 'REGISTRY'
          - `pieceType` union, required
            - 'CUSTOM'
            - 'OFFICIAL'
          - `pieceName` string, required
          - `pieceVersion` string, required
          - `actionName` string
          - `input` object, required
          - `inputUiInfo` object, required
            - `currentSelectedData` unknown
            - `customizedInputs` object
            - `lastTestDate` string
          - `errorHandlingOptions` object
            - `continueOnFailure` object
              - …
            - `retryOnFailure` object
              - …
      - object
        - `name` string, required
        - `valid` boolean, required
        - `displayName` string, required
        - `type` 'BRANCH', required
        - `settings` object, required
          - `conditions` array[], required
            - union[]
              - …
          - `inputUiInfo` object, required
            - `currentSelectedData` unknown
            - `customizedInputs` object
            - `lastTestDate` string
  - object
    - `type` 'ADD_ACTION', required
    - `request` object, required
      - `parentStep` string, required
      - `stepLocationRelativeToParent` union
        - 'INSIDE_TRUE_BRANCH'
        - 'INSIDE_FALSE_BRANCH'
        - 'AFTER'
        - 'INSIDE_LOOP'
      - `action` union, required
        - object
          - `name` string, required
          - `valid` boolean, required
          - `displayName` string, required
          - `type` 'CODE', required
          - `settings` object, required
            - `sourceCode` object, required
              - …
            - `input` object, required
            - `inputUiInfo` object
              - …
            - `errorHandlingOptions` object
              - …
        - object
          - `name` string, required
          - `valid` boolean, required
          - `displayName` string, required
          - `type` 'LOOP_ON_ITEMS', required
          - `settings` object, required
            - `items` string, required
            - `inputUiInfo` object, required
              - …
        - object
          - `name` string, required
          - `valid` boolean, required
          - `displayName` string, required
          - `type` 'PIECE', required
          - `settings` object, required
            - `packageType` union, required
              - …
            - `pieceType` union, required
              - …
            - `pieceName` string, required
            - `pieceVersion` string, required
            - `actionName` string
            - `input` object, required
            - `inputUiInfo` object, required
              - …
            - `errorHandlingOptions` object
              - …
        - object
          - `name` string, required
          - `valid` boolean, required
          - `displayName` string, required
          - `type` 'BRANCH', required
          - `settings` object, required
            - `conditions` array[], required
              - …
            - `inputUiInfo` object, required
              - …
  - object
    - `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
          - `pieceName` string, required
          - `pieceVersion` string, required
          - `pieceType` union, required
            - 'CUSTOM'
            - 'OFFICIAL'
          - `packageType` union, required
            - 'ARCHIVE'
            - 'REGISTRY'
          - `triggerName` string
          - `input` object, required
          - `inputUiInfo` object, required
            - `currentSelectedData` unknown
            - `customizedInputs` object
            - `lastTestDate` string
  - object
    - `type` 'CHANGE_FOLDER', required
    - `request` object, required
      - `folderId` string, nullable
  - object
    - `type` 'DUPLICATE_ACTION', required
    - `request` object, required
      - `stepName` string, required

## Response `200`

Default Response

## Changes

> 38 revisions in range; 1 could not be searched.

- **2024-09-03** `b95c8c8e8262` — 2 info
  - the request property `anyOf[subschema #11: Update Trigger]/request/anyOf[subschema #2]/settings/triggerName` became optional
  - the request property `anyOf[subschema #6: Import Flow]/request/trigger/anyOf[subschema #1]/settings/triggerName` became optional
- **2024-03-25** `49bc5504bd5f` — 2 breaking
  - removed `subschema #1` from the `anyOf[subschema #6: Import Flow]/request/trigger` request property `anyOf` list
  - removed `subschema #3` from the `anyOf[subschema #11: Update Trigger]/request` request property `anyOf` list
- **2024-02-22** `b8aa27750656` — 2 info
  - the endpoint scheme security `apiKey` was added to the API
  - added `subschema #3` to the `anyOf[subschema #9: Update Action]/request/anyOf[subschema #4]/settings/conditions/items/items/anyOf[subschema #2]/operator` request property `anyOf` list
- **2024-02-05** `a4b120f4a7dc` — 1 info
  - added `subschema #3` to the `anyOf[subschema #10: Add Action]/request/action/anyOf[subschema #4]/settings/conditions/items/items/anyOf[subschema #2]/operator` request property `anyOf` list
- …earlier changes not shown

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

---

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