For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Scout DocsAccess Scout
API & SDK
API & SDK
  • Endpoints
      • DELDelete a revision
      • GETList all revisions for a workflow
      • PUTMake a revision the active revision for a workflow
LogoLogo
Scout DocsAccess Scout
EndpointsRevisions

Make a revision the active revision for a workflow

Beta
PUT
https://api.scoutos.com/v2/workflows/:workflow_id/revisions/:revision_id/promote
PUT
/v2/workflows/:workflow_id/revisions/:revision_id/promote
$curl -X PUT https://api.scoutos.com/v2/workflows/workflow_id/revisions/revision_id/promote \
> -H "Authorization: Bearer <token>"
1{
2 "data": {
3 "workflow_config": {
4 "workflow_display_name": "Customer Onboarding",
5 "workflow_schema_version": "1.0",
6 "workflow_img_url": "https://cdn.scoutos.com/workflows/onboarding.png",
7 "workflow_description": "Automated workflow for new customer onboarding process",
8 "blocks": [
9 {
10 "block_archetype_id": "email_sender_v2",
11 "block_display_name": "Welcome Email Sender",
12 "block_id": "block_001",
13 "block_inputs": {
14 "recipient_email": "newuser@example.com",
15 "email_subject": "Welcome to Our Service!"
16 },
17 "is_output": false,
18 "dependencies": [
19 {
20 "block_id": "block_000",
21 "ui": {
22 "edge_type": "plusSign"
23 }
24 }
25 ],
26 "input_schema": {
27 "recipient_email": "string",
28 "email_subject": "string"
29 },
30 "ui": {
31 "dimensions": {
32 "width": 300,
33 "height": 150
34 },
35 "position": {
36 "x": 100,
37 "y": 200
38 }
39 },
40 "trigger_config": {},
41 "ignore_error": false,
42 "block_config": [
43 {
44 "id": "send_welcome_email",
45 "display_name": "Send Welcome Email",
46 "type": "boolean",
47 "default_value": true,
48 "value": true
49 }
50 ],
51 "output_schema": [
52 {
53 "status": "sent"
54 }
55 ]
56 }
57 ],
58 "notes": [
59 {
60 "id": "note_001",
61 "bgColor": "#FFFAE5",
62 "content": "Ensure email templates are updated before promotion.",
63 "author": "Jane Doe",
64 "ui": {
65 "dimensions": {
66 "width": 250,
67 "height": 100
68 },
69 "position": {
70 "x": 400,
71 "y": 100
72 }
73 }
74 }
75 ],
76 "placeholders": [
77 {
78 "block_id": "block_002",
79 "type": "triggerPlaceholder",
80 "ui": {
81 "dimensions": {
82 "width": 100,
83 "height": 100
84 },
85 "position": {
86 "x": 50,
87 "y": 50
88 }
89 },
90 "dependencies": [
91 {
92 "block_id": "block_001",
93 "ui": {
94 "edge_type": "plusSign"
95 }
96 }
97 ]
98 }
99 ],
100 "tags": [
101 "onboarding",
102 "email",
103 "automation"
104 ],
105 "is_tool": false
106 },
107 "last_updated_at": "2024-01-15T09:30:00Z",
108 "created_at": "2023-12-01T08:00:00Z",
109 "created_by": {
110 "type": "user",
111 "details": {
112 "user_id": "user_12345",
113 "org_id": "org_67890",
114 "scout_organization_id": "scout_org_001",
115 "email": {
116 "address": "jane.doe@example.com",
117 "verified": true
118 }
119 }
120 },
121 "last_updated_by": {
122 "type": "user",
123 "details": {
124 "user_id": "user_12345",
125 "org_id": "org_67890",
126 "scout_organization_id": "scout_org_001",
127 "email": {
128 "address": "jane.doe@example.com",
129 "verified": true
130 }
131 }
132 },
133 "revision_id": "rev_20240115_01",
134 "workflow_id": "wf_20231201_01",
135 "workflow_key": "customer_onboarding_v2",
136 "is_draft": false
137 }
138}
Was this page helpful?
Previous

List all environments for a workflow

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

workflow_idstringRequired
revision_idstringRequired

Response

Successful Response
dataobject or null

Errors

422
Unprocessable Entity Error