Update a workflow

POST

/v1/workflows/:workflow_id

POST

/v1/workflows/:workflow_id

1 from skyvern import Skyvern
2 
3 updated_workflow_definition = {
4     "title": "Updated Contact Forms Workflow",
5     "description": "Fill the contact form on the website",
6     "proxy_location": "RESIDENTIAL",
7     "webhook_callback_url": "https://example.com/webhook",
8     "totp_verification_url": "https://example.com/totp",
9     "totp_identifier": "4155555555",
10     "model": {"name": "gpt-4.1"},
11     "workflow_definition": {
12         "parameters": [
13             {
14                 "key": "website_url",
15                 "description": None,
16                 "parameter_type": "workflow",
17                 "workflow_parameter_type": "string",
18                 "default_value": None,
19             },
20             {
21                 "key": "name",
22                 "description": None,
23                 "parameter_type": "workflow",
24                 "workflow_parameter_type": "string",
25                 "default_value": None,
26             },
27             {
28                 "key": "additional_information",
29                 "description": None,
30                 "parameter_type": "workflow",
31                 "workflow_parameter_type": "string",
32                 "default_value": "Message: I'd love to learn more about your...
33 Phone: 123-456-7890
34 Inquiry type: sales
35 Optional Subject: Hello from [Company Here]",
36             },
37             {
38                 "key": "email",
39                 "description": None,
40                 "parameter_type": "workflow",
41                 "workflow_parameter_type": "string",
42                 "default_value": None,
43             },
44         ],
45         "blocks": [
46             {
47                 "label": "Fill_Out_Contact_Form",
48                 "continue_on_failure": True,
49                 "block_type": "navigation",
50                 "url": "{{website_url}}",
51                 "title": "Fill_Out_Contact_Form",
52                 "engine": "skyvern-1.0",
53                 "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.
54 
55 Fill out required fields as best you can using the following information:
56 {{name}}
57 {{email}}
58 {{additional_information}}",
59                 "error_code_mapping": None,
60                 "max_retries": 0,
61                 "max_steps_per_run": None,
62                 "complete_on_download": False,
63                 "download_suffix": None,
64                 "parameter_keys": [],
65                 "totp_identifier": None,
66                 "totp_verification_url": None,
67                 "cache_actions": False,
68                 "complete_criterion": "",
69                 "terminate_criterion": "",
70                 "include_action_history_in_verification": False,
71             },
72             {
73                 "label": "Extract_Email",
74                 "continue_on_failure": False,
75                 "block_type": "extraction",
76                 "url": "",
77                 "title": "Extract_Email",
78                 "data_extraction_goal": "Extract a company email if available ",
79                 "data_schema": None,
80                 "max_retries": 0,
81                 "max_steps_per_run": None,
82                 "parameter_keys": [],
83                 "cache_actions": False,
84             },
85         ],
86     },
87 }
88 skyvern = Skyvern(api_key="YOUR_API_KEY")
89 workflow = await skyvern.update_workflow(workflow_id="wpid_123", json_definition=updated_workflow_definition)
90 print(workflow)

Try it

200updateWorkflowExample

1 {
2   "workflow_id": "foo",
3   "organization_id": "foo",
4   "title": "foo",
5   "workflow_permanent_id": "foo",
6   "version": 42,
7   "is_saved_task": true,
8   "workflow_definition": {
9     "parameters": [
10       {
11         "parameter_type": "workflow",
12         "key": "foo",
13         "description": "foo",
14         "workflow_parameter_id": "foo",
15         "workflow_parameter_type": "string",
16         "workflow_id": "foo",
17         "default_value": {},
18         "created_at": "foo",
19         "modified_at": "foo",
20         "deleted_at": "foo"
21       }
22     ],
23     "blocks": [
24       {
25         "label": "foo",
26         "block_type": "for_loop",
27         "output_parameter": {
28           "parameter_type": "output",
29           "key": "foo",
30           "description": "foo",
31           "output_parameter_id": "foo",
32           "workflow_id": "foo",
33           "created_at": "foo",
34           "modified_at": "foo",
35           "deleted_at": "foo"
36         },
37         "continue_on_failure": false,
38         "model": {},
39         "loop_blocks": [
40           {
41             "label": "foo",
42             "block_type": "for_loop",
43             "output_parameter": {
44               "parameter_type": "output",
45               "key": "foo",
46               "description": "foo",
47               "output_parameter_id": "foo",
48               "workflow_id": "foo",
49               "created_at": "foo",
50               "modified_at": "foo",
51               "deleted_at": "foo"
52             },
53             "continue_on_failure": false,
54             "model": {},
55             "loop_blocks": [
56               {
57                 "label": "foo",
58                 "block_type": "for_loop",
59                 "output_parameter": {
60                   "parameter_type": "output",
61                   "key": "foo",
62                   "output_parameter_id": "foo",
63                   "workflow_id": "foo",
64                   "created_at": "foo",
65                   "modified_at": "foo"
66                 },
67                 "continue_on_failure": false,
68                 "model": {},
69                 "loop_blocks": [
70                   null
71                 ],
72                 "loop_variable_reference": "foo",
73                 "complete_if_empty": false
74               }
75             ],
76             "loop_over": {
77               "parameter_type": "workflow",
78               "key": "foo",
79               "description": "foo",
80               "workflow_parameter_id": "foo",
81               "workflow_parameter_type": "string",
82               "workflow_id": "foo",
83               "default_value": {},
84               "created_at": "foo",
85               "modified_at": "foo",
86               "deleted_at": "foo"
87             },
88             "loop_variable_reference": "foo",
89             "complete_if_empty": false
90           }
91         ],
92         "loop_over": {
93           "parameter_type": "workflow",
94           "key": "foo",
95           "description": "foo",
96           "workflow_parameter_id": "foo",
97           "workflow_parameter_type": "string",
98           "workflow_id": "foo",
99           "default_value": {},
100           "created_at": "foo",
101           "modified_at": "foo",
102           "deleted_at": "foo"
103         },
104         "loop_variable_reference": "foo",
105         "complete_if_empty": false
106       }
107     ]
108   },
109   "created_at": "foo",
110   "modified_at": "foo",
111   "description": "foo",
112   "proxy_location": "RESIDENTIAL",
113   "webhook_callback_url": "foo",
114   "totp_verification_url": "foo",
115   "totp_identifier": "foo",
116   "persist_browser_session": false,
117   "model": {},
118   "status": "published",
119   "deleted_at": "foo"
120 }

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_definitionobjectOptional

Workflow definition in JSON format

yaml_definitionstringOptional

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"

descriptionstring or null

proxy_locationenum 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:

deleted_atstring or nullformat: "date-time"

Update a workflow

Path parameters

Headers

Request

Response

Errors