Workflows

Update a workflow

Updates workflow fields like name and authentication requirement

post/workflows/update

Request body

workflowIdstring required

ID of the workflow to update

namestring

New name for the workflow

isAuthenticationRequiredboolean

Whether authentication is required for this workflow

autoSaveEnabledboolean

Whether auto-save is enabled for this workflow

timeoutMsinteger nullable

Timeout in milliseconds for workflow execution

shouldPauseOnErrorboolean

Whether to pause workflow execution on error

shouldSelfHealboolean

Whether to automatically clean up cache when workflow execution fails

shouldSaveResultFileboolean

Whether to save result files for this workflow

useProxyboolean

Whether to use proxy for this workflow

operatingSystem'Windows' | 'MacOS' | 'Linux' nullable

Operating system for browser sessions

fingerprintBrowser'Chrome' | 'Safari'

Browser fingerprint to use for sessions

maxConcurrentSessionsinteger nullable

Maximum concurrent executions for this workflow

useLoginDetectionboolean

Whether to use login detection for this workflow

blockRetryCountinteger nullable

Number of retries for failed blocks

blockBackoffStrategy'exponential' | 'linear' nullable

Backoff strategy for block retries

isOptimizedForComputerVisionboolean

Whether this workflow is optimized for computer vision blocks (uses specialized viewport and settings)

waitBetweenBlocksMsinteger

Wait time in milliseconds between executing each block

tagIdsstring[]

List of tag external IDs to associate with this workflow

workflowGroupIdstring nullable

External ID of the workflow group to assign this workflow to. Set to null to remove from any group.

useRecoveryAgentboolean

Whether to enable the recovery agent for all blocks in this workflow. When enabled, all blocks will use the recovery agent regardless of their individual settings.

executionMode'standard' | 'structured'

Execution mode for this workflow. "standard" is the default, "structured" is experimental visual mode.

executeInAgentModeboolean

Whether this workflow should execute in agent mode instead of traditional block-based execution.

Kaizen mode used when this workflow executes in agent mode. Set to null to use the organization default.

agentModeSummarySchemaobject nullable

JSON Schema that defines the structure of the execution summary when running in agent mode. Set to null to remove.

Example request

{
  "name": "Updated Workflow Name",
  "autoSaveEnabled": true,
  "timeoutMs": 3600000,
  "shouldSelfHeal": true,
  "webhooks": [
    {
      "id": "workflow_webhook_url_01h2x3y4z5a6b7c8d9e0f1g2h3",
      "url": "https://example.com/webhook1"
    },
    {
      "url": "https://example.com/webhook2"
    }
  ],
  "operatingSystem": "Windows",
  "fingerprintBrowser": "Safari",
  "maxConcurrentSessions": 10,
  "useLoginDetection": true,
  "retryConfiguration": {
    "delay": 1000,
    "retryCount": 3
  },
  "blockRetryCount": 3,
  "blockBackoffStrategy": "exponential",
  "isOptimizedForComputerVision": true,
  "waitBetweenBlocksMs": 1000,
  "tagIds": [
    "tag_01h2x3y4z5a6b7c8d9e0f1g2h3",
    "tag_01h2x3y4z5a6b7c8d9e0f1g2h4"
  ],
  "workflowGroupId": "workflow_group_01h2x3y4z5a6b7c8d9e0f1g2h3",
  "executionMode": "standard",
  "agentModeKaizenVersion": "Full"
}

Response

Workflow updated successfully

idstring required

ID of the updated workflow

namestring required

Updated name of the workflow

isAuthenticationRequiredboolean required