Update a workflow

import { SkyvernClient } from "@skyvern/client";
const skyvern = new SkyvernClient({ apiKey: "YOUR_API_KEY" });
const updatedWorkflowDefinition = {
    title: "Updated Contact Forms Workflow",
    description: "Fill the contact form on the website",
    proxy_location: "RESIDENTIAL",
    webhook_callback_url: "https://example.com/webhook",
    totp_verification_url: "https://example.com/totp",
    totp_identifier: "4155555555",
    model: { name: "gpt-4.1" },
    workflow_definition: {
        parameters: [
            {
                key: "website_url",
                description: null,
                parameter_type: "workflow",
                workflow_parameter_type: "string",
                default_value: null
            },
            {
                key: "name",
                description: null,
                parameter_type: "workflow",
                workflow_parameter_type: "string",
                default_value: null
            },
            {
                key: "additional_information",
                description: null,
                parameter_type: "workflow",
                workflow_parameter_type: "string",
                default_value: "Message: I'd love to learn more about your...\nPhone: 123-456-7890\nInquiry type: sales\nOptional Subject: Hello from [Company Here]"
            },
            {
                key: "email",
                description: null,
                parameter_type: "workflow",
                workflow_parameter_type: "string",
                default_value: null
            }
        ],
        blocks: [
            {
                label: "Fill_Out_Contact_Form",
                continue_on_failure: true,
                block_type: "navigation",
                url: "{{website_url}}",
                title: "Fill_Out_Contact_Form",
                engine: "skyvern-1.0",
                navigation_goal: "Find the contact form. Fill out the contact us form and submit it. Your goal is complete when the page says your message has been sent. In the case you can't find a contact us form, terminate.\n\nFill out required fields as best you can using the following information:\n{{name}}\n{{email}}\n{{additional_information}}",
                error_code_mapping: null,
                max_retries: 0,
                max_steps_per_run: null,
                complete_on_download: false,
                download_suffix: null,
                parameter_keys: [],
                totp_identifier: null,
                totp_verification_url: null,
                complete_criterion: "",
                terminate_criterion: "",
                include_action_history_in_verification: false
            },
            {
                label: "Extract_Email",
                continue_on_failure: false,
                block_type: "extraction",
                url: "",
                title: "Extract_Email",
                data_extraction_goal: "Extract a company email if available ",
                data_schema: null,
                max_retries: 0,
                max_steps_per_run: null,
                parameter_keys: []
            }
        ]
    }
};
const workflow = await skyvern.updateWorkflow("wpid_123", {
    json_definition: updatedWorkflowDefinition
});
console.log(workflow);

{
  "workflow_id": "string",
  "organization_id": "string",
  "title": "string",
  "workflow_permanent_id": "string",
  "version": 1,
  "is_saved_task": true,
  "workflow_definition": {
    "parameters": [
      {
        "parameter_type": "workflow",
        "key": "string",
        "description": "string",
        "workflow_parameter_id": "string",
        "workflow_parameter_type": "string",
        "workflow_id": "string",
        "default_value": {},
        "created_at": "2024-01-15T09:30:00Z",
        "modified_at": "2024-01-15T09:30:00Z",
        "deleted_at": "2024-01-15T09:30:00Z"
      }
    ],
    "blocks": [
      {
        "label": "string",
        "next_block_label": "string",
        "block_type": "conditional",
        "output_parameter": {
          "parameter_type": "output",
          "key": "string",
          "description": "string",
          "output_parameter_id": "string",
          "workflow_id": "string",
          "created_at": "2024-01-15T09:30:00Z",
          "modified_at": "2024-01-15T09:30:00Z",
          "deleted_at": "2024-01-15T09:30:00Z"
        },
        "continue_on_failure": false,
        "model": {},
        "disable_cache": false,
        "next_loop_on_failure": false,
        "branch_conditions": [
          {
            "id": "string",
            "criteria": {
              "criteria_type": "jinja2_template",
              "expression": "string",
              "description": "string"
            },
            "next_block_label": "string",
            "description": "string",
            "is_default": false
          }
        ]
      }
    ],
    "version": 1,
    "finally_block_label": "string"
  },
  "created_at": "2024-01-15T09:30:00Z",
  "modified_at": "2024-01-15T09:30:00Z",
  "is_template": false,
  "description": "string",
  "proxy_location": {},
  "webhook_callback_url": "string",
  "totp_verification_url": "string",
  "totp_identifier": "string",
  "persist_browser_session": false,
  "model": {},
  "status": "published",
  "max_screenshot_scrolls": 1,
  "extra_http_headers": {},
  "run_with": "string",
  "ai_fallback": false,
  "cache_key": "string",
  "run_sequentially": true,
  "sequential_key": "string",
  "folder_id": "string",
  "import_error": "string",
  "deleted_at": "2024-01-15T09:30:00Z"
}

Update a workflow

Path parameters

workflow_idstringRequired

The ID of the workflow to update. Workflow ID starts with wpid_.

Request

This endpoint expects an object.

json_definitionobject or nullOptional

Workflow definition in JSON format

yaml_definitionstring or nullOptional

Workflow definition in YAML format

Response

Successfully updated workflow

workflow_idstring

organization_idstring

titlestring

workflow_permanent_idstring

versioninteger

is_saved_taskboolean

workflow_definitionobject

created_atstringformat: "date-time"

modified_atstringformat: "date-time"

is_templateboolean or nullDefaults to false

descriptionstring or null

proxy_locationenum or object or map from strings to any or null

webhook_callback_urlstring or null

totp_verification_urlstring or null

totp_identifierstring or null

persist_browser_sessionboolean or nullDefaults to false

modelmap from strings to any or null

statusenum or null

Allowed values:

max_screenshot_scrollsinteger or null

extra_http_headersmap from strings to strings or null

run_withstring or null

ai_fallbackboolean or nullDefaults to false

cache_keystring or null

run_sequentiallyboolean or null

sequential_keystring or null

folder_idstring or null

import_errorstring or null

deleted_atstring or nullformat: "date-time"

Update a workflow

Path parameters

Headers

Request

Response

Errors