Skip to main content
Update workflow
import requests

url = 'https://api.simplex.sh/workflow/your_workflow_id'
headers = {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
}

# Only update specific fields
data = {
    'name': 'Updated Workflow Name',
    'metadata': 'updated, production-ready',
    'actions': [
        {
            'function': 'navigate',
            'params': {'url': 'https://example.com'}
        },
        {
            'function': 'click',
            'params': {'element_description': 'submit button'}
        }
    ]
}

response = requests.patch(url, headers=headers, json=data)
result = response.json()
print(f"Updated: {result}")
{
  "succeeded": true,
  "message": "<string>",
  "workflow": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "actions": [
      {}
    ],
    "variables": {},
    "url": "<string>",
    "metadata": "<string>"
  }
}
Update a specific workflow by its ID. Only the fields provided in the request body will be updated. You can update the workflow’s name, actions, variables, URL, and metadata.

Path Parameters

workflow_id
string<uuid>
required

The ID of the workflow to update

Body

application/json
name
string

The workflow name

actions
object[]

Array of actions in the workflow

variables
object

Variables used in the workflow

url
string

Starting URL for the workflow

metadata
string | null

Additional metadata about the workflow

Response

Workflow updated successfully

succeeded
boolean
required

Whether the request succeeded

message
string
required

Success message

workflow
object
required