Skip to main content
POST
/
workflows
/
update
Update a workflow
curl --request POST \
  --url https://api.kaizenautomation.com/workflows/update \
  --header 'Content-Type: application/json' \
  --data '
{
  "workflowId": "<string>",
  "name": "Updated Workflow Name",
  "isAuthenticationRequired": false,
  "autoSaveEnabled": true,
  "timeoutMs": 3600000,
  "shouldPauseOnError": false,
  "shouldSelfHeal": true,
  "shouldSaveResultFile": false,
  "model": "gpt-4.1-2025-04-14",
  "webhooks": [
    {
      "id": "workflow_webhook_url_01h2x3y4z5a6b7c8d9e0f1g2h3",
      "url": "https://example.com/webhook1"
    },
    {
      "url": "https://example.com/webhook2"
    }
  ],
  "useProxy": false,
  "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",
  "useRecoveryAgent": false,
  "executionMode": "standard",
  "executeInAgentMode": false,
  "agentModeSummarySchema": {}
}
'
{
  "id": "<string>",
  "name": "<string>",
  "isAuthenticationRequired": true,
  "autoSaveEnabled": true,
  "model": "gpt-4.1-mini-2025-04-14",
  "message": "Workflow updated successfully",
  "timeoutMs": 3600000,
  "shouldPauseOnError": false,
  "shouldSelfHeal": true,
  "shouldSaveResultFile": false,
  "maxConcurrentSessions": 10,
  "useProxy": false,
  "useLoginDetection": true,
  "operatingSystem": "Windows",
  "fingerprintBrowser": "Safari",
  "blockRetryCount": 3,
  "blockBackoffStrategy": "exponential",
  "isOptimizedForComputerVision": true,
  "waitBetweenBlocksMs": 1000,
  "useRecoveryAgent": false,
  "executionMode": "standard",
  "executeInAgentMode": false,
  "agentModeSummarySchema": {}
}

Body

application/json
workflowId
string
required

ID of the workflow to update

name
string

New name for the workflow

Example:

"Updated Workflow Name"

isAuthenticationRequired
boolean

Whether authentication is required for this workflow

Example:

false

autoSaveEnabled
boolean

Whether auto-save is enabled for this workflow

Example:

true

timeoutMs
integer | null

Timeout in milliseconds for workflow execution

Example:

3600000

shouldPauseOnError
boolean

Whether to pause workflow execution on error

Example:

false

shouldSelfHeal
boolean

Whether to automatically clean up cache when workflow execution fails

Example:

true

shouldSaveResultFile
boolean

Whether to save result files for this workflow

Example:

false

model

The LLM model to use for this workflow

Available options:
gpt-4.1-mini-2025-04-14,
gpt-4.1-2025-04-14,
gpt-5-2025-08-07,
gpt-5-mini-2025-08-07,
gpt-5-nano-2025-08-07,
gpt-5.1-2025-11-13,
computer-use-preview
Example:

"gpt-4.1-2025-04-14"

webhooks
object[]

List of webhooks to receive notifications when this workflow completes. Use id for updates/deletes, omit for creates.

Example:
[
{
"id": "workflow_webhook_url_01h2x3y4z5a6b7c8d9e0f1g2h3",
"url": "https://example.com/webhook1"
},
{ "url": "https://example.com/webhook2" }
]
useProxy
boolean

Whether to use proxy for this workflow

Example:

false

operatingSystem
enum<string> | null

Operating system for browser sessions

Available options:
Windows,
MacOS,
Linux
Example:

"Windows"

fingerprintBrowser
enum<string>

Browser fingerprint to use for sessions

Available options:
Chrome,
Safari
Example:

"Safari"

maxConcurrentSessions
integer | null

Maximum concurrent executions for this workflow

Example:

10

useLoginDetection
boolean

Whether to use login detection for this workflow

Example:

true

retryConfiguration
object

Retry configuration for failed blocks. Set to null to remove retries.

blockRetryCount
integer | null

Number of retries for failed blocks

Required range: x >= 0
Example:

3

blockBackoffStrategy
enum<string> | null

Backoff strategy for block retries

Available options:
exponential,
linear
Example:

"exponential"

isOptimizedForComputerVision
boolean

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

Example:

true

waitBetweenBlocksMs
integer

Wait time in milliseconds between executing each block

Required range: x >= 0
Example:

1000

tagIds
string[]

List of tag external IDs to associate with this workflow

Example:
[
"tag_01h2x3y4z5a6b7c8d9e0f1g2h3",
"tag_01h2x3y4z5a6b7c8d9e0f1g2h4"
]
workflowGroupId
string | null

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

Example:

"workflow_group_01h2x3y4z5a6b7c8d9e0f1g2h3"

useRecoveryAgent
boolean

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.

Example:

false

executionMode
enum<string>

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

Available options:
standard,
structured
Example:

"standard"

executeInAgentMode
boolean

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

Example:

false

agentModeSummarySchema
object

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

Response

Workflow updated successfully

id
string
required

ID of the updated workflow

name
string
required

Updated name of the workflow

isAuthenticationRequired
boolean
required

Whether authentication is required for this workflow

autoSaveEnabled
boolean
required

Whether auto-save is enabled for this workflow

model
required

The LLM model used for this workflow

Available options:
gpt-4.1-mini-2025-04-14,
gpt-4.1-2025-04-14,
gpt-5-2025-08-07,
gpt-5-mini-2025-08-07,
gpt-5-nano-2025-08-07,
gpt-5.1-2025-11-13,
computer-use-preview
message
string
required

Success message

Example:

"Workflow updated successfully"

timeoutMs
integer | null

Timeout in milliseconds for workflow execution

Example:

3600000

shouldPauseOnError
boolean

Whether to pause workflow execution on error

Example:

false

shouldSelfHeal
boolean

Whether to automatically clean up cache when workflow execution fails

Example:

true

shouldSaveResultFile
boolean

Whether to save result files for this workflow

Example:

false

maxConcurrentSessions
integer | null

Maximum concurrent executions for this workflow

Example:

10

useProxy
boolean

Whether to use proxy for this workflow

Example:

false

useLoginDetection
boolean

Whether to use login detection for this workflow

Example:

true

operatingSystem
enum<string> | null

Operating system for browser sessions

Available options:
Windows,
MacOS,
Linux
Example:

"Windows"

fingerprintBrowser
enum<string>

Browser fingerprint to use for sessions

Available options:
Chrome,
Safari
Example:

"Safari"

blockRetryCount
integer | null

Number of retries for failed blocks

Required range: x >= 0
Example:

3

blockBackoffStrategy
enum<string> | null

Backoff strategy for block retries

Available options:
exponential,
linear
Example:

"exponential"

isOptimizedForComputerVision
boolean

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

Example:

true

waitBetweenBlocksMs
integer

Wait time in milliseconds between executing each block

Required range: x >= 0
Example:

1000

useRecoveryAgent
boolean

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.

Example:

false

executionMode
enum<string>

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

Available options:
standard,
structured
Example:

"standard"

executeInAgentMode
boolean

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

Example:

false

agentModeSummarySchema
object

JSON Schema that defines the structure of the execution summary when running in agent mode.