Update a workflow

Beta

PUT

Path parameters

workflow_idstringRequired

Request

This endpoint expects an object.

workflow_display_namestringOptionalDefaults to Untitled

workflow_schema_versionstringOptionalDefaults to 1.0

workflow_img_urlstringOptional

workflow_descriptionstringOptional

blockslist of objectsOptional

Response

Successful Response

dataobjectOptional

PUT

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 '{}'

200Updated

1 {
2   "data": {
3     "workflow_config": {
4       "workflow_display_name": "workflow_display_name",
5       "workflow_schema_version": "workflow_schema_version",
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         }
14       ]
15     },
16     "last_updated_at": "2024-01-15T09:30:00Z",
17     "created_at": "2024-01-15T09:30:00Z",
18     "created_by": {
19       "type": "user",
20       "details": {
21         "user_id": "user_id",
22         "org_id": "org_id",
23         "scout_organization_id": "scout_organization_id",
24         "email": {
25           "key": "value"
26         }
27       }
28     },
29     "last_updated_by": {
30       "type": "user",
31       "details": {
32         "user_id": "user_id",
33         "org_id": "org_id",
34         "scout_organization_id": "scout_organization_id",
35         "email": {
36           "key": "value"
37         }
38       }
39     },
40     "revision_id": "revision_id",
41     "workflow_id": "workflow_id",
42     "is_draft": true
43   }
44 }

Built with

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 '{}'

1	{
2	"data": {
3	"workflow_config": {
4	"workflow_display_name": "workflow_display_name",
5	"workflow_schema_version": "workflow_schema_version",
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	}
14	]
15	},
16	"last_updated_at": "2024-01-15T09:30:00Z",
17	"created_at": "2024-01-15T09:30:00Z",
18	"created_by": {
19	"type": "user",
20	"details": {
21	"user_id": "user_id",
22	"org_id": "org_id",
23	"scout_organization_id": "scout_organization_id",
24	"email": {
25	"key": "value"
26	}
27	}
28	},
29	"last_updated_by": {
30	"type": "user",
31	"details": {
32	"user_id": "user_id",
33	"org_id": "org_id",
34	"scout_organization_id": "scout_organization_id",
35	"email": {
36	"key": "value"
37	}
38	}
39	},
40	"revision_id": "revision_id",
41	"workflow_id": "workflow_id",
42	"is_draft": true
43	}
44	}