---
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
        - 'AFTER'
        - 'INSIDE_LOOP'
        - 'INSIDE_BRANCH'
      - `branchIndex` number
  - 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
      - `schemaVersion` string, nullable
  - object
    - `type` 'CHANGE_NAME', required
    - `request` object, required
      - `displayName` string, required
  - object
    - `type` 'DELETE_ACTION', required
    - `request` object, required
      - `names` string[], required
  - object
    - `type` 'UPDATE_ACTION', required
    - `request` union, required
      - object
        - `name` string, required
        - `valid` boolean, required
        - `displayName` string, required
        - `skip` boolean
        - `customLogoUrl` string
        - `type` 'CODE', required
        - `settings` object, required
          - `sourceCode` object, required
            - `packageJson` string, required
            - `code` string, required
          - `input` object, required
          - `inputUiInfo` object
            - `sampleDataFileId` string
            - `lastTestDate` string
            - `customizedInputs` object
            - `currentSelectedData` unknown
          - `errorHandlingOptions` object
            - `continueOnFailure` object
              - …
            - `retryOnFailure` object
              - …
      - object
        - `name` string, required
        - `valid` boolean, required
        - `displayName` string, required
        - `skip` boolean
        - `customLogoUrl` string
        - `type` 'LOOP_ON_ITEMS', required
        - `settings` object, required
          - `items` string, required
          - `inputUiInfo` object, required
            - `sampleDataFileId` string
            - `lastTestDate` string
            - `customizedInputs` object
            - `currentSelectedData` unknown
      - object
        - `name` string, required
        - `valid` boolean, required
        - `displayName` string, required
        - `skip` boolean
        - `customLogoUrl` string
        - `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
            - `sampleDataFileId` string
            - `lastTestDate` string
            - `customizedInputs` object
            - `currentSelectedData` unknown
          - `errorHandlingOptions` object
            - `continueOnFailure` object
              - …
            - `retryOnFailure` object
              - …
      - object
        - `name` string, required
        - `valid` boolean, required
        - `displayName` string, required
        - `skip` boolean
        - `customLogoUrl` string
        - `type` 'ROUTER', required
        - `settings` object, required
          - `branches` union[], required
            - union
              - …
          - `executionType` union, required
            - 'EXECUTE_ALL_MATCH'
            - 'EXECUTE_FIRST_MATCH'
          - `inputUiInfo` object, required
            - `sampleDataFileId` string
            - `lastTestDate` string
            - `customizedInputs` object
            - `currentSelectedData` unknown
  - object
    - `type` 'ADD_ACTION', required
    - `request` object, required
      - `parentStep` string, required
      - `stepLocationRelativeToParent` union
        - 'AFTER'
        - 'INSIDE_LOOP'
        - 'INSIDE_BRANCH'
      - `branchIndex` number
      - `action` union, required
        - object
          - `name` string, required
          - `valid` boolean, required
          - `displayName` string, required
          - `skip` boolean
          - `customLogoUrl` string
          - `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
          - `skip` boolean
          - `customLogoUrl` string
          - `type` 'LOOP_ON_ITEMS', required
          - `settings` object, required
            - `items` string, required
            - `inputUiInfo` object, required
              - …
        - object
          - `name` string, required
          - `valid` boolean, required
          - `displayName` string, required
          - `skip` boolean
          - `customLogoUrl` string
          - `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
          - `skip` boolean
          - `customLogoUrl` string
          - `type` 'ROUTER', required
          - `settings` object, required
            - `branches` union[], required
              - …
            - `executionType` union, 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
            - `sampleDataFileId` string
            - `lastTestDate` string
            - `customizedInputs` object
            - `currentSelectedData` unknown
  - object
    - `type` 'CHANGE_FOLDER', required
    - `request` object, required
      - `folderId` string, nullable
  - object
    - `type` 'DUPLICATE_ACTION', required
    - `request` object, required
      - `stepName` string, required
  - object
    - `type` 'DELETE_BRANCH', required
    - `request` object, required
      - `branchIndex` number, required
      - `stepName` string, required
  - object
    - `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
    - `type` 'DUPLICATE_BRANCH', required
    - `request` object, required
      - `branchIndex` number, required
      - `stepName` string, required
  - object
    - `type` 'SET_SKIP_ACTION', required
    - `request` object, required
      - `names` string[], required
      - `skip` boolean, required

## Response `200`

Default Response

## Changes

- **2024-12-31** `3c05b427e5b5` — 4 breaking, 2 warning, 2 info
  - added the new required request property `anyOf[subschema #17: Skip Action]/request/names`
  - added the new required request property `anyOf[subschema #8: Delete Action]/request/names`
  - removed `subschema #1, subschema #2, subschema #3, subschema #4` from the `anyOf[subschema #10: Add Action]/request/action` request property `anyOf` list
  - removed `subschema #1, subschema #2, subschema #3, subschema #4` from the `anyOf[subschema #9: Update Action]/request` request property `anyOf` list
  - …4 more
- **2024-12-04** `3c82a272ab74` — 2 breaking, 3 info
  - removed `subschema #1, subschema #2, subschema #3, subschema #4` from the `anyOf[subschema #10: Add Action]/request/action` request property `anyOf` list
  - removed `subschema #1, subschema #2, subschema #3, subschema #4` from the `anyOf[subschema #9: Update Action]/request` request property `anyOf` list
  - added `subschema #17: Skip Action` to the request body `anyOf` list
  - added `subschema #1, subschema #2, subschema #3, subschema #4` to the `anyOf[subschema #10: Add Action]/request/action` request property `anyOf` list
  - …1 more
- …earlier changes not shown

[Full history](https://skmtc.dev/activeboxes/apis/activeboxes-documentation/changes/v1/flows/:id/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)