Update workflow folder

Update a workflow’s folder assignment for the latest version

PUT /v1/workflows/{workflow_permanent_id}/folder

Update workflow folder

cURL

curl --request PUT \
  --url https://api.skyvern.com/v1/workflows/{workflow_permanent_id}/folder \
  --header 'Content-Type: application/json' \
  --data '
{
  "folder_id": "<string>"
}
'

200

{
  "workflow_id": "<string>",
  "organization_id": "<string>",
  "title": "<string>",
  "workflow_permanent_id": "<string>",
  "version": 123,
  "is_saved_task": true,
  "workflow_definition": {
    "parameters": [
      {
        "key": "<string>",
        "workflow_parameter_id": "<string>",
        "workflow_parameter_type": "string",
        "workflow_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "parameter_type": "workflow",
        "description": "<string>",
        "default_value": "<string>",
        "deleted_at": "2023-11-07T05:31:56Z"
      }
    ],
    "blocks": [
      {
        "label": "<string>",
        "output_parameter": {
          "key": "<string>",
          "output_parameter_id": "<string>",
          "workflow_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "parameter_type": "output",
          "description": "<string>",
          "deleted_at": "2023-11-07T05:31:56Z"
        },
        "next_block_label": "<string>",
        "block_type": "conditional",
        "continue_on_failure": false,
        "model": {},
        "disable_cache": false,
        "next_loop_on_failure": false,
        "branch_conditions": [
          {
            "id": "<string>",
            "criteria": {
              "expression": "<string>",
              "criteria_type": "jinja2_template",
              "description": "<string>"
            },
            "next_block_label": "<string>",
            "description": "<string>",
            "is_default": false
          }
        ]
      }
    ],
    "version": 1,
    "finally_block_label": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "is_template": false,
  "description": "<string>",
  "proxy_location": "RESIDENTIAL",
  "webhook_callback_url": "<string>",
  "totp_verification_url": "<string>",
  "totp_identifier": "<string>",
  "persist_browser_session": false,
  "model": {},
  "status": "published",
  "max_screenshot_scrolls": 123,
  "extra_http_headers": {},
  "run_with": "agent",
  "ai_fallback": true,
  "cache_key": "<string>",
  "adaptive_caching": false,
  "code_version": 123,
  "generate_script_on_terminal": false,
  "run_sequentially": true,
  "sequential_key": "<string>",
  "folder_id": "<string>",
  "import_error": "<string>",
  "deleted_at": "2023-11-07T05:31:56Z"
}

Headers

x-api-key · string | null

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Path Parameters

workflow_permanent_id · string · required

Workflow permanent ID

Example:

"wpid_123"

Body

application/json

Request model for updating a workflow's folder assignment

folder_id · string | null

Folder ID to assign workflow to. Set to null to remove from folder.

Response

200

application/json

Successfully updated workflow folder

workflow_id · string · required

organization_id · string · required

title · string · required

workflow_permanent_id · string · required

version · integer · required

is_saved_task · boolean · required

workflow_definition · WorkflowDefinition · object · required

Show child attributes

created_at · string<date-time> · required

modified_at · string<date-time> · required

is_template · boolean · default: false

description · string | null

proxy_location · enum<string> GeoTarget · object Proxy Location · object

Available options: RESIDENTIAL, US-CA, US-NY, US-TX, US-FL, US-WA, RESIDENTIAL_ES, RESIDENTIAL_IE, RESIDENTIAL_GB, RESIDENTIAL_IN, RESIDENTIAL_JP, RESIDENTIAL_FR, RESIDENTIAL_DE, RESIDENTIAL_NZ, RESIDENTIAL_ZA, RESIDENTIAL_AR, RESIDENTIAL_AU, RESIDENTIAL_BR, RESIDENTIAL_TR, RESIDENTIAL_CA, RESIDENTIAL_MX, RESIDENTIAL_IT, RESIDENTIAL_NL, RESIDENTIAL_PH, RESIDENTIAL_KR, RESIDENTIAL_ISP, NONE

webhook_callback_url · string | null

totp_verification_url · string | null

totp_identifier · string | null

persist_browser_session · boolean · default: false

model · Model · object

status · enum<string> · default: published

Available options: published, draft, auto_generated, importing, import_failed

max_screenshot_scrolls · integer | null

extra_http_headers · Extra Http Headers · object

Show child attributes

run_with · string · default: agent

ai_fallback · boolean · default: true

cache_key · string | null

adaptive_caching · boolean · default: false

code_version · integer | null

generate_script_on_terminal · boolean · default: false

run_sequentially · boolean | null

sequential_key · string | null

folder_id · string | null

import_error · string | null

deleted_at · string<date-time> | null