Update a workflow

Beta

PUT

https://api-prod.scoutos.com/v2/workflows/:workflow_id

PUT

/v2/workflows/:workflow_id

1 curl -X PUT https://api-prod.scoutos.com/v2/workflows/workflow_id \
2      -H "Authorization: Bearer <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "workflow_display_name": "Untitled",
6   "workflow_schema_version": "1.0",
7   "workflow_img_url": "workflow_img_url",
8   "workflow_description": "workflow_description",
9   "blocks": [
10     {
11       "block_archetype_id": "block_archetype_id",
12       "block_display_name": "block_display_name",
13       "block_id": "block_id",
14       "block_inputs": {},
15       "is_output": false,
16       "dependencies": [
17         {
18           "block_id": "block_id",
19           "ui": {
20             "edge_type": "plusSign"
21           }
22         }
23       ],
24       "input_schema": {},
25       "ui": {
26         "dimensions": {
27           "width": 0,
28           "height": 0
29         },
30         "position": {
31           "x": 0,
32           "y": 0
33         }
34       },
35       "trigger_config": {},
36       "ignore_error": false
37     }
38   ],
39   "notes": [
40     {
41       "id": "id",
42       "bgColor": "bgColor",
43       "content": "",
44       "author": "Your name",
45       "ui": {
46         "dimensions": {
47           "width": 0,
48           "height": 0
49         },
50         "position": {
51           "x": 0,
52           "y": 0
53         }
54       }
55     }
56   ],
57   "placeholders": [
58     {
59       "block_id": "block_id",
60       "type": "triggerPlaceholder",
61       "ui": {
62         "dimensions": {
63           "width": 0,
64           "height": 0
65         },
66         "position": {
67           "x": 0,
68           "y": 0
69         }
70       },
71       "dependencies": [
72         {
73           "block_id": "block_id",
74           "ui": {
75             "edge_type": "plusSign"
76           }
77         }
78       ]
79     }
80   ],
81   "tags": [
82     "tags"
83   ],
84   "is_tool": false
85 }'

Try it

200Updated

1 {
2   "data": {
3     "workflow_config": {
4       "workflow_display_name": "Untitled",
5       "workflow_schema_version": "1.0",
6       "workflow_img_url": "workflow_img_url",
7       "workflow_description": "workflow_description",
8       "blocks": [
9         {
10           "block_archetype_id": "block_archetype_id",
11           "block_display_name": "block_display_name",
12           "block_id": "block_id",
13           "block_inputs": {},
14           "is_output": false,
15           "dependencies": [
16             {
17               "block_id": "block_id",
18               "ui": {
19                 "edge_type": "plusSign"
20               }
21             }
22           ],
23           "input_schema": {},
24           "ui": {
25             "dimensions": {
26               "width": 0,
27               "height": 0
28             },
29             "position": {
30               "x": 0,
31               "y": 0
32             }
33           },
34           "trigger_config": {},
35           "ignore_error": false
36         }
37       ],
38       "notes": [
39         {
40           "id": "id",
41           "bgColor": "bgColor",
42           "content": "",
43           "author": "Your name",
44           "ui": {
45             "dimensions": {
46               "width": 0,
47               "height": 0
48             },
49             "position": {
50               "x": 0,
51               "y": 0
52             }
53           }
54         }
55       ],
56       "placeholders": [
57         {
58           "block_id": "block_id",
59           "type": "triggerPlaceholder",
60           "ui": {
61             "dimensions": {
62               "width": 0,
63               "height": 0
64             },
65             "position": {
66               "x": 0,
67               "y": 0
68             }
69           },
70           "dependencies": [
71             {
72               "block_id": "block_id",
73               "ui": {
74                 "edge_type": "plusSign"
75               }
76             }
77           ]
78         }
79       ],
80       "tags": [
81         "tags"
82       ],
83       "is_tool": false
84     },
85     "workflow_key": "workflow_key",
86     "last_updated_at": "last_updated_at",
87     "created_at": "created_at",
88     "created_by": {
89       "type": "user",
90       "details": {
91         "user_id": "user_id",
92         "org_id": "org_id",
93         "scout_organization_id": "scout_organization_id",
94         "email": {}
95       }
96     },
97     "last_updated_by": {
98       "type": "user",
99       "details": {
100         "user_id": "user_id",
101         "org_id": "org_id",
102         "scout_organization_id": "scout_organization_id",
103         "email": {}
104       }
105     },
106     "revision_id": "revision_id",
107     "workflow_id": "workflow_id",
108     "is_draft": false
109   }
110 }

Path parameters

workflow_idstringRequired

Request

This endpoint expects an object.

workflow_display_namestringOptionalDefaults to Untitled

workflow_schema_versionstringOptionalDefaults to 1.0

workflow_img_urlstring or nullOptional

workflow_descriptionstring or nullOptional

blockslist of objectsOptional

noteslist of objectsOptional

placeholderslist of objectsOptional

tagslist of stringsOptional

is_toolbooleanOptionalDefaults to false

Response

Successful Response

dataobject or nullOptional

Update a workflow

Path parameters

Headers

Request

Response

Errors