API ReferenceManagementFlows and Styles
POST
/v1/mgmt/flow/import

Import a flow within a project utilizing a management key.

This endpoint is used to import a flow to a project. The request items for the flow and screen this endpoint can be received from the export flow endpoint.

See Also

  • See Flow Overview for more information on flows.
  • See Manage Flows for more information on managing (export, import, delete, disable, enable) flows.

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<ProjectId:ManagementKey\>

Try it

/v1/mgmt/flow/import

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

flowIdstring

flowobject

screensarray<object>

Status codeDescription
200OK
curl -X POST "https://api.descope.com/v1/mgmt/flow/import" \
  -d '{
  "flowId": "string",
  "flow": {
    "id": "string",
    "version": 0,
    "name": "string",
    "description": "string",
    "dsl": {},
    "modifiedTime": "string",
    "etag": "string",
    "disabled": true,
    "translate": true,
    "translateConnectorID": "string",
    "translateSourceLang": "string",
    "translateTargetLangs": [
      "string"
    ],
    "fingerprint": true,
    "widget": true
  },
  "screens": [
    {
      "id": "string",
      "version": 0,
      "flowId": "string",
      "inputs": [
        {
          "type": "string",
          "name": "string",
          "required": true,
          "visible": true,
          "displayName": "string",
          "displayType": "string",
          "dependsOn": [
            "string"
          ],
          "nameValueMap": {},
          "contextAware": true,
          "options": [
            {
              "value": "string",
              "label": "string"
            }
          ],
          "defaultValue": "string",
          "helperText": "string"
        }
      ],
      "interactions": [
        {
          "id": "string",
          "type": "string",
          "label": "string",
          "icon": "string",
          "subType": "string"
        }
      ],
      "htmlTemplate": {},
      "componentsVersion": "string"
    }
  ]
}'

{
  "flow": {
    "id": "string",
    "version": 0,
    "name": "string",
    "description": "string",
    "dsl": {},
    "modifiedTime": "string",
    "etag": "string",
    "disabled": true,
    "translate": true,
    "translateConnectorID": "string",
    "translateSourceLang": "string",
    "translateTargetLangs": [
      "string"
    ],
    "fingerprint": true,
    "widget": true
  },
  "screens": [
    {
      "id": "string",
      "version": 0,
      "flowId": "string",
      "inputs": [
        {
          "type": "string",
          "name": "string",
          "required": true,
          "visible": true,
          "displayName": "string",
          "displayType": "string",
          "dependsOn": [
            "string"
          ],
          "nameValueMap": {},
          "contextAware": true,
          "options": [
            {
              "value": "string",
              "label": "string"
            }
          ],
          "defaultValue": "string",
          "helperText": "string"
        }
      ],
      "interactions": [
        {
          "id": "string",
          "type": "string",
          "label": "string",
          "icon": "string",
          "subType": "string"
        }
      ],
      "htmlTemplate": {},
      "componentsVersion": "string"
    }
  ]
}

Was this helpful?

Previous

Export Flow

Next

Export Theme