---
title: "Import workflow"
method: POST
path: "/workflow_builder/import"
tags: ["Workflow Builder"]
---

# Import workflow

`POST /workflow_builder/import`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/workflow_builder/import`
- Auth: none declared

Imports a single Workflow.

## Request body

- object
  - `workflow` WorkflowBuilderWorkflowPayload: A workflow import payload, that has expanded users and groups for transportation between environments
    - `_id` string
    - `uuid` string
    - `name` string, required
    - `type` string, required
    - `description` string, nullable
    - `namespace` WorkflowBuilderWorkflowPayloadNamespace
      - `type` unknown
      - `_id` string
      - `name` string
      - `accessControl` WorkflowBuilderWorkflowPayloadNamespaceAccessControl
        - `read` string[]
        - `execute` string[]
        - `write` string[]
        - `manage` string[]
    - `preAutomationTime` integer: Time (milliseconds) automation would have taken someone to complete without using IAP.
    - `sla` integer
    - `metadata` WorkflowBuilderWorkflowPayloadMetadata: Deprecated. If present, preAutomationTime and sla are lifted to the top level on import; this property is not persisted.
      - `preAutomationTime` integer
      - `sla` integer
    - `tasks` WorkflowBuilderWorkflowPayloadTasks, required
      - `workflow_start` WorkflowBuilderWorkflowPayloadTasksWorkflowStart, required
        - `name` string
        - `summary` string
        - `groups` WorkflowBuilderWorkflowPayloadTasksWorkflowStartGroupsItems[]
          - `name` string, required
          - `provenance` string, required
        - `x` number, double: Stores the x coordinate used by canvasVersion: 1 workflows
        - `y` number, double: Stores the y coordinate used by canvasVersion: 1 workflows
        - `nodeLocation` WorkflowBuilderWorkflowPayloadTasksWorkflowStartNodeLocation: Stores the coordinates used by canvasVersion: 3 workflows
          - `x` number, double
          - `y` number, double
      - `workflow_end` WorkflowBuilderWorkflowPayloadTasksWorkflowEnd, required
        - `name` string
        - `summary` string
        - `groups` WorkflowBuilderWorkflowPayloadTasksWorkflowEndGroupsItems[]
          - `name` string, required
          - `provenance` string, required
        - `x` number, double: Stores the x coordinate used by canvasVersion: 1 workflows
        - `y` number, double: Stores the y coordinate used by canvasVersion: 1 workflows
        - `nodeLocation` WorkflowBuilderWorkflowPayloadTasksWorkflowEndNodeLocation: Stores the coordinates used by canvasVersion: 3 workflows
          - `x` number, double
          - `y` number, double
      - `error_handler` WorkflowBuilderWorkflowPayloadTasksErrorHandler: Deprecated gen2-specific feature
        - `name` 'childJob', required
        - `summary` string, required
        - `description` string, required
        - `app` string, required
        - `variables` WorkflowBuilderWorkflowPayloadTasksErrorHandlerVariables, required
          - `incoming` WorkflowBuilderWorkflowPayloadTasksErrorHandlerVariablesIncoming, required
          - `outgoing` WorkflowBuilderWorkflowPayloadTasksErrorHandlerVariablesOutgoing, required
          - `error` string
          - `decorators` WorkflowBuilderWorkflowPayloadTasksErrorHandlerVariablesDecoratorsItems[]
            - `type` 'encryption'
            - `pointer` string, json-pointer
        - `deprecated` boolean
        - `scheduled` boolean
        - `groups` WorkflowBuilderWorkflowPayloadTasksErrorHandlerGroupsItems[], required
          - `name` string, required
          - `provenance` string, required
        - `type` 'operation', required
        - `retrySettings` WorkflowBuilderWorkflowPayloadTasksErrorHandlerRetrySettings: Retry settings for a task.
          - `state` WorkflowBuilderWorkflowPayloadTasksErrorHandlerRetrySettingsStateItems[], required: Finish states the task will retry on. The task will retry on any of the included states.
          - `autoRetry` boolean, required: Whether the task is set to retry automatically or manually.
          - `limit` integer, required: Limit of retries on a task before it will take normal transitions and stop retrying.
          - `delay` integer, required: Delay between each retry in milliseconds.
          - `count` integer: Current retry count used for workflow engine job processing
    - `transitions` WorkflowBuilderWorkflowPayloadTransitions, required
      - `workflow_start` WorkflowBuilderWorkflowPayloadTransitionsWorkflowStart
      - `workflow_end` WorkflowBuilderWorkflowPayloadTransitionsWorkflowEnd
      - `error_handler` WorkflowBuilderWorkflowPayloadTransitionsErrorHandler
    - `scenarios` WorkflowBuilderWorkflowPayloadScenariosItems[]
      - `name` string, required
      - `description` string
      - `input` WorkflowBuilderWorkflowPayloadScenariosItemsInput, required
      - `taskMocks` WorkflowBuilderWorkflowPayloadScenariosItemsTaskMocks
      - `last_updated` string, date-time
      - `last_updated_by` union
        - WorkflowBuilderWorkflowPayloadScenariosItemsLastUpdatedBy0
          - `username` string, required
          - `provenance` string, required
        - string
    - `errorHandler` WorkflowBuilderWorkflowPayloadErrorHandler: Deprecated gen2-specific feature
      - `type` string
      - `name` string
    - `font_size` integer: Deprecated, unused, gen1-specific feature
    - `groups` WorkflowBuilderWorkflowPayloadGroupsItems[], required
      - `name` string, required
      - `provenance` string, required
    - `created` string, date-time
    - `created_by` union
      - WorkflowBuilderWorkflowPayloadCreatedBy0
        - `username` string, required
        - `provenance` string, required
      - string
    - `createdVersion` string
    - `last_updated` string, date-time
    - `last_updated_by` union
      - WorkflowBuilderWorkflowPayloadLastUpdatedBy0
        - `username` string, required
        - `provenance` string, required
      - string
    - `lastUpdatedVersion` string: This value represents the semantic version of the application that last modified it. For workflows with canvasVersion = 1, this field will refer to the version of Workflow Builder. For workflows with canvasVersion > 1, this field will refer to the version of Studio.
    - `tags` WorkflowBuilderWorkflowPayloadTagsItems[]
      - `_id` string, required
      - `name` string, required
      - `description` string, required
    - `canvasVersion` '1' | '1.5' | '2' | '3'
    - `encodingVersion` '1'
    - `inputSchema` WorkflowBuilderWorkflowPayloadInputSchema
    - `outputSchema` WorkflowBuilderWorkflowPayloadOutputSchema
    - `outputData` object: Deprecated gen2-specific feature
    - `decorators` WorkflowBuilderWorkflowPayloadDecoratorsItems[]
      - `type` 'encryption'
      - `pointer` string, json-pointer
    - `migrationVersion` integer
  - `options` WorkflowBuilderImportPostRequestBodyContentApplicationJsonSchemaOptions
    - `adapterMap` WorkflowBuilderImportPostRequestBodyContentApplicationJsonSchemaOptionsAdapterMap
    - `validate` boolean: If true, run deep validation after import. Default false.

## Response `200`

Import status Object

- WorkflowBuilderImportWorkflowResponse200

## Other responses

- `500`: Error response from API

## Changes

- **2026-10-31** `2095cc90e583`: 2 info
  - api tag `Workflow Builder` added
  - api tag `workflowBuilder` removed

[Operation history](https://skmtc.dev/itential/apis/itential-2/changes/workflow_builder/import/post.md)

---

[API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)