@epilot/sdk 2.0.0-beta.6 → 2.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. package/LICENSE +21 -0
  2. package/dist/apis/automation.d.cts +2 -2
  3. package/dist/apis/automation.d.ts +2 -2
  4. package/dist/apis/customer-portal.cjs +1 -1
  5. package/dist/apis/customer-portal.d.cts +2 -2
  6. package/dist/apis/customer-portal.d.ts +2 -2
  7. package/dist/apis/customer-portal.js +1 -1
  8. package/dist/apis/erp-integration.cjs +1 -1
  9. package/dist/apis/erp-integration.d.cts +2 -2
  10. package/dist/apis/erp-integration.d.ts +2 -2
  11. package/dist/apis/erp-integration.js +1 -1
  12. package/dist/apis/journey.d.cts +2 -2
  13. package/dist/apis/journey.d.ts +2 -2
  14. package/dist/apis/kanban.d.cts +2 -2
  15. package/dist/apis/kanban.d.ts +2 -2
  16. package/dist/apis/organization.cjs +1 -1
  17. package/dist/apis/organization.d.cts +2 -2
  18. package/dist/apis/organization.d.ts +2 -2
  19. package/dist/apis/organization.js +1 -1
  20. package/dist/apis/workflow.d.cts +2 -2
  21. package/dist/apis/workflow.d.ts +2 -2
  22. package/dist/{automation.d-sRCRiHKf.d.cts → automation.d-KOiZ6ru5.d.cts} +2 -24
  23. package/dist/{automation.d-sRCRiHKf.d.ts → automation.d-KOiZ6ru5.d.ts} +2 -24
  24. package/dist/{customer-portal.d-D7cJvhBK.d.ts → customer-portal.d-Bh9NF8cY.d.cts} +598 -99
  25. package/dist/{customer-portal.d-D7cJvhBK.d.cts → customer-portal.d-Bh9NF8cY.d.ts} +598 -99
  26. package/dist/{erp-integration.d-3LmxMirP.d.cts → erp-integration.d-DOhxy4P5.d.cts} +409 -15
  27. package/dist/{erp-integration.d-3LmxMirP.d.ts → erp-integration.d-DOhxy4P5.d.ts} +409 -15
  28. package/dist/index.d.cts +7 -7
  29. package/dist/index.d.ts +7 -7
  30. package/dist/{journey.d-DkBvO_Wa.d.ts → journey.d-C4N4t1Rh.d.cts} +122 -4
  31. package/dist/{journey.d-DkBvO_Wa.d.cts → journey.d-C4N4t1Rh.d.ts} +122 -4
  32. package/dist/kanban.d-CtSt3uX2.d.cts +745 -0
  33. package/dist/kanban.d-CtSt3uX2.d.ts +745 -0
  34. package/dist/organization.d-Bd2Hmk8v.d.cts +1244 -0
  35. package/dist/organization.d-Bd2Hmk8v.d.ts +1244 -0
  36. package/dist/{workflow.d-EPa2OdVW.d.cts → workflow.d-DvhTpEtU.d.cts} +45 -3
  37. package/dist/{workflow.d-EPa2OdVW.d.ts → workflow.d-DvhTpEtU.d.ts} +45 -3
  38. package/package.json +10 -11
  39. package/definitions/access-token-runtime.json +0 -1
  40. package/definitions/access-token.json +0 -663
  41. package/definitions/address-runtime.json +0 -1
  42. package/definitions/address-suggestions-runtime.json +0 -1
  43. package/definitions/address-suggestions.json +0 -582
  44. package/definitions/address.json +0 -578
  45. package/definitions/ai-agents-runtime.json +0 -1
  46. package/definitions/ai-agents.json +0 -1711
  47. package/definitions/app-runtime.json +0 -1
  48. package/definitions/app.json +0 -4443
  49. package/definitions/audit-logs-runtime.json +0 -1
  50. package/definitions/audit-logs.json +0 -305
  51. package/definitions/automation-runtime.json +0 -1
  52. package/definitions/automation.json +0 -4850
  53. package/definitions/billing-runtime.json +0 -1
  54. package/definitions/billing.json +0 -837
  55. package/definitions/blueprint-manifest-runtime.json +0 -1
  56. package/definitions/blueprint-manifest.json +0 -3376
  57. package/definitions/consent-runtime.json +0 -1
  58. package/definitions/consent.json +0 -344
  59. package/definitions/customer-portal-runtime.json +0 -1
  60. package/definitions/customer-portal.json +0 -15000
  61. package/definitions/dashboard-runtime.json +0 -1
  62. package/definitions/dashboard.json +0 -484
  63. package/definitions/data-management-runtime.json +0 -1
  64. package/definitions/data-management.json +0 -962
  65. package/definitions/deduplication-runtime.json +0 -1
  66. package/definitions/deduplication.json +0 -183
  67. package/definitions/design-runtime.json +0 -1
  68. package/definitions/design.json +0 -1423
  69. package/definitions/document-runtime.json +0 -1
  70. package/definitions/document.json +0 -758
  71. package/definitions/email-settings-runtime.json +0 -1
  72. package/definitions/email-settings.json +0 -2627
  73. package/definitions/email-template-runtime.json +0 -1
  74. package/definitions/email-template.json +0 -1419
  75. package/definitions/entity-mapping-runtime.json +0 -1
  76. package/definitions/entity-mapping.json +0 -1642
  77. package/definitions/entity-runtime.json +0 -1
  78. package/definitions/entity.json +0 -10074
  79. package/definitions/environments-runtime.json +0 -1
  80. package/definitions/environments.json +0 -363
  81. package/definitions/erp-integration-runtime.json +0 -1
  82. package/definitions/erp-integration.json +0 -5845
  83. package/definitions/event-catalog-runtime.json +0 -1
  84. package/definitions/event-catalog.json +0 -1051
  85. package/definitions/file-runtime.json +0 -1
  86. package/definitions/file.json +0 -2842
  87. package/definitions/iban-runtime.json +0 -1
  88. package/definitions/iban.json +0 -132
  89. package/definitions/journey-runtime.json +0 -1
  90. package/definitions/journey.json +0 -2341
  91. package/definitions/kanban-runtime.json +0 -1
  92. package/definitions/kanban.json +0 -929
  93. package/definitions/message-runtime.json +0 -1
  94. package/definitions/message.json +0 -2660
  95. package/definitions/metering-runtime.json +0 -1
  96. package/definitions/metering.json +0 -2321
  97. package/definitions/notes-runtime.json +0 -1
  98. package/definitions/notes.json +0 -1531
  99. package/definitions/notification-runtime.json +0 -1
  100. package/definitions/notification.json +0 -1425
  101. package/definitions/organization-runtime.json +0 -1
  102. package/definitions/organization.json +0 -629
  103. package/definitions/partner-directory-runtime.json +0 -1
  104. package/definitions/partner-directory.json +0 -1718
  105. package/definitions/permissions-runtime.json +0 -1
  106. package/definitions/permissions.json +0 -1480
  107. package/definitions/pricing-runtime.json +0 -1
  108. package/definitions/pricing-tier-runtime.json +0 -1
  109. package/definitions/pricing-tier.json +0 -105
  110. package/definitions/pricing.json +0 -9884
  111. package/definitions/purpose-runtime.json +0 -1
  112. package/definitions/purpose.json +0 -524
  113. package/definitions/sandbox-runtime.json +0 -1
  114. package/definitions/sandbox.json +0 -453
  115. package/definitions/submission-runtime.json +0 -1
  116. package/definitions/submission.json +0 -313
  117. package/definitions/targeting-runtime.json +0 -1
  118. package/definitions/targeting.json +0 -1474
  119. package/definitions/template-variables-runtime.json +0 -1
  120. package/definitions/template-variables.json +0 -1408
  121. package/definitions/user-runtime.json +0 -1
  122. package/definitions/user.json +0 -2408
  123. package/definitions/validation-rules-runtime.json +0 -1
  124. package/definitions/validation-rules.json +0 -1491
  125. package/definitions/webhooks-runtime.json +0 -1
  126. package/definitions/webhooks.json +0 -1525
  127. package/definitions/workflow-definition-runtime.json +0 -1
  128. package/definitions/workflow-definition.json +0 -3417
  129. package/definitions/workflow-runtime.json +0 -1
  130. package/definitions/workflow.json +0 -4106
  131. package/dist/kanban.d-DUClxyBG.d.cts +0 -630
  132. package/dist/kanban.d-DUClxyBG.d.ts +0 -630
  133. package/dist/organization.d-BOLK3v9o.d.cts +0 -628
  134. package/dist/organization.d-BOLK3v9o.d.ts +0 -628
package/definitions/workflow-definition.json DELETED
@@ -1,3417 +0,0 @@
1
- {
2
- "openapi": "3.0.0",
3
- "info": {
4
- "title": "Workflows Definitions",
5
- "version": "1.0.0",
6
- "description": "Service for Workflow Definitions for different processes inside of an Organization\n"
7
- },
8
- "servers": [
9
- {
10
- "url": "https://workflows-definition.sls.epilot.io"
11
- }
12
- ],
13
- "security": [
14
- {
15
- "BearerAuth": []
16
- }
17
- ],
18
- "paths": {
19
- "/v1/workflows/limits/max-allowed": {
20
- "get": {
21
- "operationId": "getMaxAllowedLimit",
22
- "summary": "getMaxAllowedLimit",
23
- "description": "Get limits and number of created executions for an Organization.",
24
- "tags": [
25
- "Workflows"
26
- ],
27
- "responses": {
28
- "200": {
29
- "description": "A combo of current number of workflows, and the max allowed number of workflows.",
30
- "content": {
31
- "application/json": {
32
- "schema": {
33
- "$ref": "#/components/schemas/MaxAllowedLimit"
34
- },
35
- "example": {
36
- "currentNoOfWorkflows": 5,
37
- "maxAllowed": 7
38
- }
39
- }
40
- }
41
- },
42
- "500": {
43
- "description": "Other errors",
44
- "content": {
45
- "application/json": {
46
- "schema": {
47
- "$ref": "#/components/schemas/ErrorResp"
48
- }
49
- }
50
- }
51
- }
52
- }
53
- }
54
- },
55
- "/v1/workflows/definitions": {
56
- "get": {
57
- "operationId": "getDefinitions",
58
- "summary": "getDefinitions",
59
- "description": "Retrieve all Workflow Definitions from an Organization",
60
- "tags": [
61
- "Workflows"
62
- ],
63
- "responses": {
64
- "200": {
65
- "description": "Success - definitions loaded with success. Empty array if org has no definitions.",
66
- "content": {
67
- "application/json": {
68
- "schema": {
69
- "type": "array",
70
- "items": {
71
- "$ref": "#/components/schemas/WorkflowDefinition"
72
- }
73
- },
74
- "example": [
75
- {
76
- "id": "25n2k52ja",
77
- "name": "Lead Qualification",
78
- "assignedTo": [
79
- "18625",
80
- "90252"
81
- ],
82
- "description": "Lead Qualification description",
83
- "lastUpdateTime": "2021-08-04T21:13:50.373Z",
84
- "creationTime": "2021-08-04T21:13:50.373Z",
85
- "dueDate": "2021-08-04T21:13:50.373Z",
86
- "flow": [
87
- {
88
- "id": "5892na2",
89
- "name": "Initial Information Gathering",
90
- "order": 1,
91
- "type": "SECTION",
92
- "steps": [
93
- {
94
- "id": "2hja82a",
95
- "name": "Call client and confirm address and product",
96
- "type": "STEP",
97
- "order": 1,
98
- "assignedTo": [
99
- "123482"
100
- ]
101
- },
102
- {
103
- "id": "ga92ha2",
104
- "name": "Check product availability",
105
- "type": "STEP",
106
- "order": 2,
107
- "assignedTo": [
108
- "123482"
109
- ]
110
- },
111
- {
112
- "id": "jga92ha",
113
- "name": "Send email confirming contact with the client",
114
- "type": "STEP",
115
- "order": 3,
116
- "assignedTo": [
117
- "123482"
118
- ]
119
- }
120
- ]
121
- },
122
- {
123
- "id": "0a7g22a",
124
- "name": "Print and send catalog",
125
- "type": "STEP",
126
- "order": 2,
127
- "assignedTo": [
128
- "123482"
129
- ]
130
- }
131
- ]
132
- }
133
- ]
134
- }
135
- }
136
- },
137
- "500": {
138
- "description": "Other errors",
139
- "content": {
140
- "application/json": {
141
- "schema": {
142
- "$ref": "#/components/schemas/ErrorResp"
143
- }
144
- }
145
- }
146
- }
147
- }
148
- },
149
- "post": {
150
- "operationId": "createDefinition",
151
- "summary": "createDefinition",
152
- "description": "Create a Workflow Definition.",
153
- "tags": [
154
- "Workflows"
155
- ],
156
- "requestBody": {
157
- "description": "Workflow Definition payload",
158
- "required": true,
159
- "content": {
160
- "application/json": {
161
- "schema": {
162
- "$ref": "#/components/schemas/WorkflowDefinition"
163
- },
164
- "example": {
165
- "name": "Lead Qualification",
166
- "description": "Lead Qualification description",
167
- "dueDate": "2022-08-04T12:00:00.000Z",
168
- "assignedTo": [
169
- "952802",
170
- "80225"
171
- ],
172
- "flow": [
173
- {
174
- "name": "Initial Information Gathering",
175
- "order": 1,
176
- "type": "SECTION",
177
- "steps": [
178
- {
179
- "name": "Call client and confirm address and product",
180
- "type": "STEP",
181
- "order": 1,
182
- "assignedTo": [
183
- "123482"
184
- ]
185
- },
186
- {
187
- "name": "Check product availability",
188
- "type": "STEP",
189
- "order": 2,
190
- "assignedTo": [
191
- "123482"
192
- ]
193
- },
194
- {
195
- "name": "Send email confirming contact with the client",
196
- "type": "STEP",
197
- "order": 3,
198
- "assignedTo": [
199
- "123482"
200
- ]
201
- }
202
- ]
203
- },
204
- {
205
- "name": "Print and send catalog",
206
- "type": "STEP",
207
- "order": 2,
208
- "assignedTo": [
209
- "123482"
210
- ]
211
- }
212
- ]
213
- }
214
- }
215
- }
216
- },
217
- "responses": {
218
- "201": {
219
- "description": "Success - if the definition is created successfully",
220
- "content": {
221
- "application/json": {
222
- "schema": {
223
- "$ref": "#/components/schemas/WorkflowDefinition"
224
- },
225
- "example": {
226
- "id": "25n2k52ja",
227
- "name": "Lead Qualification",
228
- "description": "Lead Qualification description",
229
- "lastUpdateTime": "2021-08-04T21:13:50.373Z",
230
- "creationTime": "2021-08-04T21:13:50.373Z",
231
- "dueDate": "2022-08-04T12:00:00.000Z",
232
- "assignedTo": [
233
- "952802",
234
- "80225"
235
- ],
236
- "flow": [
237
- {
238
- "id": "5892na2",
239
- "name": "Initial Information Gathering",
240
- "order": 1,
241
- "type": "SECTION",
242
- "steps": [
243
- {
244
- "id": "2hja82a",
245
- "name": "Call client and confirm address and product",
246
- "type": "STEP",
247
- "order": 1,
248
- "assignedTo": [
249
- "48829"
250
- ]
251
- },
252
- {
253
- "id": "ga92ha2",
254
- "name": "Check product availability",
255
- "type": "STEP",
256
- "order": 2,
257
- "assignedTo": [
258
- "45390"
259
- ]
260
- },
261
- {
262
- "id": "jga92ha",
263
- "name": "Send email confirming contact with the client",
264
- "type": "STEP",
265
- "order": 3,
266
- "assignedTo": [
267
- "8230"
268
- ]
269
- }
270
- ]
271
- },
272
- {
273
- "id": "0a7g22a",
274
- "name": "Print and send catalog",
275
- "type": "STEP",
276
- "order": 2,
277
- "assignedTo": [
278
- "8239"
279
- ]
280
- }
281
- ]
282
- }
283
- }
284
- }
285
- },
286
- "400": {
287
- "description": "Validation Errors",
288
- "content": {
289
- "application/json": {
290
- "schema": {
291
- "$ref": "#/components/schemas/ErrorResp"
292
- }
293
- }
294
- }
295
- },
296
- "401": {
297
- "description": "Authentication Errors",
298
- "content": {
299
- "application/json": {
300
- "schema": {
301
- "$ref": "#/components/schemas/ErrorResp"
302
- }
303
- }
304
- }
305
- },
306
- "500": {
307
- "description": "Other errors",
308
- "content": {
309
- "application/json": {
310
- "schema": {
311
- "$ref": "#/components/schemas/ErrorResp"
312
- }
313
- }
314
- }
315
- }
316
- }
317
- }
318
- },
319
- "/v2/flows/templates": {
320
- "get": {
321
- "operationId": "listFlowTemplates",
322
- "summary": "listFlowTemplates",
323
- "description": "List all Flow Templates for a customer. Optionally, you can filter flow templates by trigger values.",
324
- "tags": [
325
- "Flows V2"
326
- ],
327
- "parameters": [
328
- {
329
- "in": "query",
330
- "name": "trigger_type",
331
- "schema": {
332
- "type": "string",
333
- "enum": [
334
- "automation",
335
- "manual",
336
- "journey_submission"
337
- ]
338
- },
339
- "required": false,
340
- "description": "Type of trigger for whom to filter flow templates",
341
- "example": "journey_submission"
342
- },
343
- {
344
- "in": "query",
345
- "name": "trigger_source_id",
346
- "schema": {
347
- "type": "string"
348
- },
349
- "required": false,
350
- "description": "Id of the trigger source to filter flow templates. Interpretation depends on **trigger_type**:\n- **automation**: use an `{automation_flow_id}` value\n- **journey_submission**: use a `{journey_id}` value\n- **manual**: this parameter is ignored; you can optionally filter by `{trigger_schema}`\n",
351
- "example": "j208g0aj-08g9agajggak-g9aug9-892kgl1m"
352
- },
353
- {
354
- "in": "query",
355
- "name": "trigger_schema",
356
- "schema": {
357
- "type": "string"
358
- },
359
- "required": false,
360
- "description": "Schema of the trigger source to filter flow templates. This parameter only makes sense when **trigger_type** is `manual`\n",
361
- "example": "opportunity"
362
- }
363
- ],
364
- "responses": {
365
- "200": {
366
- "description": "Success - flow templates loaded with success. Empty array if customer has no flows defined.",
367
- "content": {
368
- "application/json": {
369
- "schema": {
370
- "$ref": "#/components/schemas/FlowTemplatesList"
371
- }
372
- }
373
- }
374
- },
375
- "500": {
376
- "description": "Other errors",
377
- "content": {
378
- "application/json": {
379
- "schema": {
380
- "$ref": "#/components/schemas/ErrorResp"
381
- }
382
- }
383
- }
384
- }
385
- }
386
- },
387
- "post": {
388
- "operationId": "createFlowTemplate",
389
- "summary": "createFlowTemplate",
390
- "description": "Create a new Flow Template.",
391
- "tags": [
392
- "Flows V2"
393
- ],
394
- "requestBody": {
395
- "description": "Flow Template payload",
396
- "required": true,
397
- "content": {
398
- "application/json": {
399
- "schema": {
400
- "$ref": "#/components/schemas/CreateFlowTemplate"
401
- }
402
- }
403
- }
404
- },
405
- "responses": {
406
- "201": {
407
- "description": "Success - if the flow template is created successfully",
408
- "content": {
409
- "application/json": {
410
- "schema": {
411
- "$ref": "#/components/schemas/FlowTemplate"
412
- }
413
- }
414
- }
415
- },
416
- "400": {
417
- "description": "Validation Errors",
418
- "content": {
419
- "application/json": {
420
- "schema": {
421
- "$ref": "#/components/schemas/ErrorResp"
422
- }
423
- }
424
- }
425
- },
426
- "401": {
427
- "description": "Authentication Errors",
428
- "content": {
429
- "application/json": {
430
- "schema": {
431
- "$ref": "#/components/schemas/ErrorResp"
432
- }
433
- }
434
- }
435
- },
436
- "500": {
437
- "description": "Other errors",
438
- "content": {
439
- "application/json": {
440
- "schema": {
441
- "$ref": "#/components/schemas/ErrorResp"
442
- }
443
- }
444
- }
445
- }
446
- }
447
- }
448
- },
449
- "/v2/flows/templates:search": {
450
- "post": {
451
- "operationId": "searchFlowTemplates",
452
- "summary": "searchFlowTemplates",
453
- "description": "Search for flow templates by name, trigger type, enabled status, and more.",
454
- "tags": [
455
- "Flows V2"
456
- ],
457
- "requestBody": {
458
- "description": "Search for flow templates by name, trigger type, enabled status, and more.",
459
- "required": true,
460
- "content": {
461
- "application/json": {
462
- "schema": {
463
- "$ref": "#/components/schemas/SearchFlowTemplates"
464
- },
465
- "example": {
466
- "name": "Lead Qualification",
467
- "definition_id": "25n2k52ja",
468
- "trigger_type": "journey_submission",
469
- "enabled": true,
470
- "from": 0,
471
- "size": 10
472
- }
473
- }
474
- }
475
- },
476
- "responses": {
477
- "200": {
478
- "description": "Success - flow templates loaded with success. Empty array if customer has no flows defined.",
479
- "content": {
480
- "application/json": {
481
- "schema": {
482
- "type": "object",
483
- "properties": {
484
- "hits": {
485
- "type": "number"
486
- },
487
- "results": {
488
- "type": "array",
489
- "items": {
490
- "$ref": "#/components/schemas/FlowTemplate"
491
- }
492
- }
493
- }
494
- }
495
- }
496
- }
497
- },
498
- "500": {
499
- "description": "Other errors",
500
- "content": {
501
- "application/json": {
502
- "schema": {
503
- "$ref": "#/components/schemas/ErrorResp"
504
- }
505
- }
506
- }
507
- }
508
- }
509
- }
510
- },
511
- "/v2/flows/templates/{flowId}": {
512
- "get": {
513
- "operationId": "getFlowTemplate",
514
- "summary": "getFlowTemplate",
515
- "description": "Get specific FLow template for a customer",
516
- "tags": [
517
- "Flows V2"
518
- ],
519
- "parameters": [
520
- {
521
- "in": "path",
522
- "name": "flowId",
523
- "schema": {
524
- "$ref": "#/components/schemas/FlowTemplateId"
525
- },
526
- "required": true
527
- }
528
- ],
529
- "responses": {
530
- "200": {
531
- "description": "Returns the Flow Template",
532
- "content": {
533
- "application/json": {
534
- "schema": {
535
- "$ref": "#/components/schemas/FlowTemplate"
536
- }
537
- }
538
- }
539
- },
540
- "400": {
541
- "description": "Validation Errors",
542
- "content": {
543
- "application/json": {
544
- "schema": {
545
- "$ref": "#/components/schemas/ErrorResp"
546
- }
547
- }
548
- }
549
- },
550
- "401": {
551
- "description": "Authentication Errors",
552
- "content": {
553
- "application/json": {
554
- "schema": {
555
- "$ref": "#/components/schemas/ErrorResp"
556
- }
557
- }
558
- }
559
- },
560
- "404": {
561
- "description": "Definition Not found",
562
- "content": {
563
- "application/json": {
564
- "schema": {
565
- "$ref": "#/components/schemas/DefinitionNotFoundResp"
566
- }
567
- }
568
- }
569
- },
570
- "500": {
571
- "description": "Other errors",
572
- "content": {
573
- "application/json": {
574
- "schema": {
575
- "$ref": "#/components/schemas/ErrorResp"
576
- }
577
- }
578
- }
579
- }
580
- }
581
- },
582
- "put": {
583
- "operationId": "updateFlowTemplate",
584
- "summary": "updateFlowTemplate",
585
- "description": "Update Flow Template.",
586
- "tags": [
587
- "Flows V2"
588
- ],
589
- "parameters": [
590
- {
591
- "in": "path",
592
- "name": "flowId",
593
- "schema": {
594
- "$ref": "#/components/schemas/FlowTemplateId"
595
- },
596
- "required": true
597
- }
598
- ],
599
- "requestBody": {
600
- "description": "Flow Template payload",
601
- "required": true,
602
- "content": {
603
- "application/json": {
604
- "schema": {
605
- "$ref": "#/components/schemas/FlowTemplate"
606
- }
607
- }
608
- }
609
- },
610
- "responses": {
611
- "200": {
612
- "description": "Flow template has been updated successfully",
613
- "content": {
614
- "application/json": {
615
- "schema": {
616
- "$ref": "#/components/schemas/FlowTemplate"
617
- }
618
- }
619
- }
620
- },
621
- "400": {
622
- "description": "Validation Errors",
623
- "content": {
624
- "application/json": {
625
- "schema": {
626
- "$ref": "#/components/schemas/ErrorResp"
627
- }
628
- }
629
- }
630
- },
631
- "401": {
632
- "description": "Authentication Errors",
633
- "content": {
634
- "application/json": {
635
- "schema": {
636
- "$ref": "#/components/schemas/ErrorResp"
637
- }
638
- }
639
- }
640
- },
641
- "500": {
642
- "description": "Other errors",
643
- "content": {
644
- "application/json": {
645
- "schema": {
646
- "$ref": "#/components/schemas/ErrorResp"
647
- }
648
- }
649
- }
650
- }
651
- }
652
- },
653
- "delete": {
654
- "operationId": "deleteFlowTemplate",
655
- "summary": "deleteFlowTemplate",
656
- "description": "Delete Flow Template.",
657
- "tags": [
658
- "Flows V2"
659
- ],
660
- "parameters": [
661
- {
662
- "in": "path",
663
- "name": "flowId",
664
- "schema": {
665
- "$ref": "#/components/schemas/FlowTemplateId"
666
- },
667
- "required": true,
668
- "description": "Id of the flow template to de deleted."
669
- }
670
- ],
671
- "responses": {
672
- "204": {
673
- "description": "Flow template has been deleted successfully"
674
- },
675
- "401": {
676
- "description": "Failed to authenticate",
677
- "content": {
678
- "application/json": {
679
- "schema": {
680
- "$ref": "#/components/schemas/ErrorResp"
681
- }
682
- }
683
- }
684
- },
685
- "404": {
686
- "description": "No definition found"
687
- }
688
- }
689
- }
690
- },
691
- "/v2/flows/templates/{flowId}/duplicate": {
692
- "post": {
693
- "operationId": "duplicateFlowTemplate",
694
- "summary": "duplicateFlowTemplate",
695
- "description": "Duplicate a Flow Template from an existing workflow.",
696
- "tags": [
697
- "Flows V2"
698
- ],
699
- "parameters": [
700
- {
701
- "in": "path",
702
- "name": "flowId",
703
- "schema": {
704
- "$ref": "#/components/schemas/FlowTemplateId"
705
- },
706
- "required": true
707
- }
708
- ],
709
- "responses": {
710
- "201": {
711
- "description": "Flow template has been duplicated successfully",
712
- "content": {
713
- "application/json": {
714
- "schema": {
715
- "$ref": "#/components/schemas/FlowTemplate"
716
- }
717
- }
718
- }
719
- },
720
- "400": {
721
- "description": "Validation Errors",
722
- "content": {
723
- "application/json": {
724
- "schema": {
725
- "$ref": "#/components/schemas/ErrorResp"
726
- }
727
- }
728
- }
729
- },
730
- "401": {
731
- "description": "Authentication Errors",
732
- "content": {
733
- "application/json": {
734
- "schema": {
735
- "$ref": "#/components/schemas/ErrorResp"
736
- }
737
- }
738
- }
739
- },
740
- "500": {
741
- "description": "Other errors",
742
- "content": {
743
- "application/json": {
744
- "schema": {
745
- "$ref": "#/components/schemas/ErrorResp"
746
- }
747
- }
748
- }
749
- }
750
- }
751
- }
752
- },
753
- "/v2/flows/templates/{flowId}/export": {
754
- "get": {
755
- "operationId": "exportFlowTemplate",
756
- "summary": "exportFlowTemplate",
757
- "description": "Export a Flow Template with all referenced automations resolved and bundled alongside.",
758
- "tags": [
759
- "Flows V2"
760
- ],
761
- "parameters": [
762
- {
763
- "in": "path",
764
- "name": "flowId",
765
- "schema": {
766
- "$ref": "#/components/schemas/FlowTemplateId"
767
- },
768
- "required": true
769
- }
770
- ],
771
- "responses": {
772
- "200": {
773
- "description": "Exported flow template with resolved automations",
774
- "content": {
775
- "application/json": {
776
- "schema": {
777
- "$ref": "#/components/schemas/FlowTemplateExport"
778
- }
779
- }
780
- }
781
- },
782
- "401": {
783
- "description": "Authentication Errors",
784
- "content": {
785
- "application/json": {
786
- "schema": {
787
- "$ref": "#/components/schemas/ErrorResp"
788
- }
789
- }
790
- }
791
- },
792
- "404": {
793
- "description": "Flow template not found",
794
- "content": {
795
- "application/json": {
796
- "schema": {
797
- "$ref": "#/components/schemas/ErrorResp"
798
- }
799
- }
800
- }
801
- },
802
- "500": {
803
- "description": "Other errors",
804
- "content": {
805
- "application/json": {
806
- "schema": {
807
- "$ref": "#/components/schemas/ErrorResp"
808
- }
809
- }
810
- }
811
- }
812
- }
813
- }
814
- },
815
- "/v2/flows/templates/import": {
816
- "post": {
817
- "operationId": "importFlowTemplate",
818
- "summary": "importFlowTemplate",
819
- "description": "Import a Flow Template from an export payload. Creates all automations and the flow in the caller's organization.",
820
- "tags": [
821
- "Flows V2"
822
- ],
823
- "requestBody": {
824
- "description": "Export payload containing the flow template and resolved automations",
825
- "required": true,
826
- "content": {
827
- "application/json": {
828
- "schema": {
829
- "$ref": "#/components/schemas/FlowTemplateExport"
830
- }
831
- }
832
- }
833
- },
834
- "responses": {
835
- "201": {
836
- "description": "Flow template imported successfully",
837
- "content": {
838
- "application/json": {
839
- "schema": {
840
- "$ref": "#/components/schemas/FlowTemplateImportResult"
841
- }
842
- }
843
- }
844
- },
845
- "400": {
846
- "description": "Validation Errors",
847
- "content": {
848
- "application/json": {
849
- "schema": {
850
- "$ref": "#/components/schemas/ErrorResp"
851
- }
852
- }
853
- }
854
- },
855
- "401": {
856
- "description": "Authentication Errors",
857
- "content": {
858
- "application/json": {
859
- "schema": {
860
- "$ref": "#/components/schemas/ErrorResp"
861
- }
862
- }
863
- }
864
- },
865
- "500": {
866
- "description": "Other errors",
867
- "content": {
868
- "application/json": {
869
- "schema": {
870
- "$ref": "#/components/schemas/ErrorResp"
871
- }
872
- }
873
- }
874
- }
875
- }
876
- }
877
- },
878
- "/v1/workflows/definitions/{definitionId}": {
879
- "get": {
880
- "operationId": "getDefinition",
881
- "summary": "getDefinition",
882
- "description": "Get specific Definition by id from the Organization.",
883
- "tags": [
884
- "Workflows"
885
- ],
886
- "parameters": [
887
- {
888
- "in": "path",
889
- "name": "definitionId",
890
- "schema": {
891
- "type": "string"
892
- },
893
- "required": true,
894
- "description": "Short uuid (length 8) to identify the Workflow Definition.",
895
- "example": "7hj28a"
896
- }
897
- ],
898
- "responses": {
899
- "200": {
900
- "description": "Returns the Workflow definition",
901
- "content": {
902
- "application/json": {
903
- "schema": {
904
- "$ref": "#/components/schemas/WorkflowDefinition"
905
- },
906
- "example": {
907
- "id": "25n2k52ja",
908
- "name": "Lead Qualification",
909
- "dueDate": "2022-08-04T12:00:00.000Z",
910
- "assignedTo": [
911
- "952802",
912
- "80225"
913
- ],
914
- "lastUpdateTime": "2021-08-04T21:13:50.373Z",
915
- "creationTime": "2021-08-04T21:13:50.373Z",
916
- "flow": [
917
- {
918
- "id": "5892na2",
919
- "name": "Initial Information Gathering",
920
- "order": 1,
921
- "type": "SECTION",
922
- "steps": [
923
- {
924
- "id": "2hja82a",
925
- "name": "Call client and confirm address and product",
926
- "type": "STEP",
927
- "order": 1,
928
- "assignedTo": [
929
- "923432"
930
- ]
931
- },
932
- {
933
- "id": "ga92ha2",
934
- "name": "Check product availability",
935
- "type": "STEP",
936
- "order": 2,
937
- "assignedTo": [
938
- "45488"
939
- ]
940
- },
941
- {
942
- "id": "jga92ha",
943
- "name": "Send email confirming contact with the client",
944
- "type": "STEP",
945
- "order": 3,
946
- "assignedTo": [
947
- "45488"
948
- ]
949
- }
950
- ]
951
- },
952
- {
953
- "id": "0a7g22a",
954
- "name": "Print and send catalog",
955
- "type": "STEP",
956
- "order": 2,
957
- "assignedTo": [
958
- "8988"
959
- ]
960
- }
961
- ],
962
- "closingReasons": [
963
- {
964
- "id": "ffoowef",
965
- "title": "test"
966
- },
967
- {
968
- "id": "hebwoeu",
969
- "title": "Closing because all"
970
- },
971
- {
972
- "id": "mbnoenq",
973
- "title": "Better offer"
974
- }
975
- ]
976
- }
977
- }
978
- }
979
- },
980
- "400": {
981
- "description": "Validation Errors",
982
- "content": {
983
- "application/json": {
984
- "schema": {
985
- "$ref": "#/components/schemas/ErrorResp"
986
- }
987
- }
988
- }
989
- },
990
- "401": {
991
- "description": "Authentication Errors",
992
- "content": {
993
- "application/json": {
994
- "schema": {
995
- "$ref": "#/components/schemas/ErrorResp"
996
- }
997
- }
998
- }
999
- },
1000
- "404": {
1001
- "description": "Definition Not found",
1002
- "content": {
1003
- "application/json": {
1004
- "schema": {
1005
- "$ref": "#/components/schemas/DefinitionNotFoundResp"
1006
- }
1007
- }
1008
- }
1009
- },
1010
- "500": {
1011
- "description": "Other errors",
1012
- "content": {
1013
- "application/json": {
1014
- "schema": {
1015
- "$ref": "#/components/schemas/ErrorResp"
1016
- }
1017
- }
1018
- }
1019
- }
1020
- }
1021
- },
1022
- "put": {
1023
- "operationId": "updateDefinition",
1024
- "summary": "updateDefinition",
1025
- "description": "Update Workflow Definition.",
1026
- "tags": [
1027
- "Workflows"
1028
- ],
1029
- "parameters": [
1030
- {
1031
- "in": "path",
1032
- "name": "definitionId",
1033
- "schema": {
1034
- "type": "string"
1035
- },
1036
- "required": true,
1037
- "description": "Short uuid (length 8) to identify the Workflow Definition.",
1038
- "example": "7hj28a"
1039
- }
1040
- ],
1041
- "requestBody": {
1042
- "description": "Workflow Definition payload",
1043
- "required": true,
1044
- "content": {
1045
- "application/json": {
1046
- "schema": {
1047
- "$ref": "#/components/schemas/WorkflowDefinition"
1048
- },
1049
- "example": {
1050
- "id": "25n2k52ja",
1051
- "name": "Lead Qualification",
1052
- "dueDate": "2022-08-04T12:00:00.000Z",
1053
- "assignedTo": [
1054
- "952802",
1055
- "80225"
1056
- ],
1057
- "lastUpdateTime": "2021-08-04T21:13:50.373Z",
1058
- "creationTime": "2021-08-04T21:13:50.373Z",
1059
- "flow": [
1060
- {
1061
- "id": "5892na2",
1062
- "name": "Initial Information Gathering",
1063
- "order": 1,
1064
- "type": "SECTION",
1065
- "steps": [
1066
- {
1067
- "id": "2hja82a",
1068
- "name": "Call client and confirm address and product",
1069
- "type": "STEP",
1070
- "order": 1,
1071
- "assignedTo": [
1072
- "8988"
1073
- ]
1074
- },
1075
- {
1076
- "id": "ga92ha2",
1077
- "name": "Check product availability",
1078
- "type": "STEP",
1079
- "order": 2,
1080
- "assignedTo": [
1081
- "8988"
1082
- ]
1083
- },
1084
- {
1085
- "id": "jga92ha",
1086
- "name": "Send email confirming contact with the client",
1087
- "type": "STEP",
1088
- "order": 3,
1089
- "assignedTo": [
1090
- "8988"
1091
- ]
1092
- }
1093
- ]
1094
- },
1095
- {
1096
- "id": "0a7g22a",
1097
- "name": "Print and send catalog",
1098
- "type": "STEP",
1099
- "order": 2,
1100
- "assignedTo": [
1101
- "8988"
1102
- ]
1103
- }
1104
- ]
1105
- }
1106
- }
1107
- }
1108
- },
1109
- "responses": {
1110
- "200": {
1111
- "description": "Success - if the definition is updated successfully",
1112
- "content": {
1113
- "application/json": {
1114
- "schema": {
1115
- "$ref": "#/components/schemas/WorkflowDefinition"
1116
- },
1117
- "example": {
1118
- "id": "25n2k52ja",
1119
- "name": "Lead Qualification",
1120
- "dueDate": "2022-08-04T12:00:00.000Z",
1121
- "assignedTo": [
1122
- "952802",
1123
- "80225"
1124
- ],
1125
- "lastUpdateTime": "2021-08-04T21:13:50.373Z",
1126
- "creationTime": "2021-08-04T21:13:50.373Z",
1127
- "flow": [
1128
- {
1129
- "id": "5892na2",
1130
- "name": "Initial Information Gathering",
1131
- "order": 1,
1132
- "type": "SECTION",
1133
- "steps": [
1134
- {
1135
- "id": "2hja82a",
1136
- "name": "Call client and confirm address and product",
1137
- "type": "STEP",
1138
- "order": 1,
1139
- "assignedTo": [
1140
- "1"
1141
- ]
1142
- },
1143
- {
1144
- "id": "ga92ha2",
1145
- "name": "Check product availability",
1146
- "type": "STEP",
1147
- "order": 2,
1148
- "assignedTo": [
1149
- "56645"
1150
- ]
1151
- },
1152
- {
1153
- "id": "jga92ha",
1154
- "name": "Send email confirming contact with the client",
1155
- "type": "STEP",
1156
- "order": 3,
1157
- "assignedTo": [
1158
- "949923"
1159
- ]
1160
- }
1161
- ]
1162
- },
1163
- {
1164
- "id": "0a7g22a",
1165
- "name": "Print and send catalog",
1166
- "type": "STEP",
1167
- "order": 2,
1168
- "assignedTo": [
1169
- "156645"
1170
- ]
1171
- }
1172
- ]
1173
- }
1174
- }
1175
- }
1176
- },
1177
- "400": {
1178
- "description": "Validation Errors",
1179
- "content": {
1180
- "application/json": {
1181
- "schema": {
1182
- "$ref": "#/components/schemas/ErrorResp"
1183
- }
1184
- }
1185
- }
1186
- },
1187
- "401": {
1188
- "description": "Authentication Errors",
1189
- "content": {
1190
- "application/json": {
1191
- "schema": {
1192
- "$ref": "#/components/schemas/ErrorResp"
1193
- }
1194
- }
1195
- }
1196
- },
1197
- "500": {
1198
- "description": "Other errors",
1199
- "content": {
1200
- "application/json": {
1201
- "schema": {
1202
- "$ref": "#/components/schemas/ErrorResp"
1203
- }
1204
- }
1205
- }
1206
- }
1207
- }
1208
- },
1209
- "delete": {
1210
- "operationId": "deleteDefinition",
1211
- "summary": "deleteDefinition",
1212
- "description": "Delete Workflow Definition.",
1213
- "tags": [
1214
- "Workflows"
1215
- ],
1216
- "parameters": [
1217
- {
1218
- "in": "path",
1219
- "name": "definitionId",
1220
- "schema": {
1221
- "type": "string"
1222
- },
1223
- "required": true,
1224
- "description": "Id of the definition to de deleted.",
1225
- "example": "CustomerRequest"
1226
- }
1227
- ],
1228
- "responses": {
1229
- "204": {
1230
- "description": "Success - if the definition is deleted successfully"
1231
- },
1232
- "401": {
1233
- "description": "Failed to authenticate",
1234
- "content": {
1235
- "application/json": {
1236
- "schema": {
1237
- "$ref": "#/components/schemas/ErrorResp"
1238
- }
1239
- }
1240
- }
1241
- },
1242
- "404": {
1243
- "description": "No definition found"
1244
- }
1245
- }
1246
- }
1247
- },
1248
- "/v1/workflows/closing-reasons": {
1249
- "get": {
1250
- "operationId": "getAllClosingReasons",
1251
- "summary": "getAllClosingReasons",
1252
- "description": "Get all Closing Reasons defined in the organization by default all Active.",
1253
- "parameters": [
1254
- {
1255
- "in": "query",
1256
- "name": "includeInactive",
1257
- "schema": {
1258
- "type": "boolean"
1259
- },
1260
- "required": false,
1261
- "description": "Filter Closing Reasons by status like active inactiv",
1262
- "example": true
1263
- }
1264
- ],
1265
- "tags": [
1266
- "Closing Reason"
1267
- ],
1268
- "responses": {
1269
- "200": {
1270
- "description": "Returns the entire catalog of closing reasons per organization",
1271
- "content": {
1272
- "application/json": {
1273
- "schema": {
1274
- "$ref": "#/components/schemas/ClosingReasons"
1275
- }
1276
- }
1277
- }
1278
- }
1279
- }
1280
- },
1281
- "post": {
1282
- "operationId": "createClosingReason",
1283
- "summary": "createClosingReason",
1284
- "description": "A created Closing Reason is stored for the organization and will be displayed in the library of reasons.",
1285
- "tags": [
1286
- "Closing Reason"
1287
- ],
1288
- "requestBody": {
1289
- "description": "closing reason to store",
1290
- "required": true,
1291
- "content": {
1292
- "application/json": {
1293
- "schema": {
1294
- "$ref": "#/components/schemas/ClosingReason"
1295
- },
1296
- "example": {
1297
- "title": "better offer",
1298
- "description": "A customer closes the process because he found something better"
1299
- }
1300
- }
1301
- }
1302
- },
1303
- "responses": {
1304
- "201": {
1305
- "description": "closing reason is stored successfully in the repository",
1306
- "content": {
1307
- "application/json": {
1308
- "schema": {
1309
- "$ref": "#/components/schemas/ClosingReason"
1310
- }
1311
- }
1312
- }
1313
- }
1314
- }
1315
- }
1316
- },
1317
- "/v2/workflows/closing-reasons/{reasonId}": {
1318
- "get": {
1319
- "operationId": "getClosingReason",
1320
- "summary": "getClosingReason",
1321
- "description": "Get specific closing reason by id from the organisation.",
1322
- "tags": [
1323
- "Closing Reason"
1324
- ],
1325
- "parameters": [
1326
- {
1327
- "in": "path",
1328
- "name": "reasonId",
1329
- "schema": {
1330
- "type": "string",
1331
- "example": "x739cew"
1332
- },
1333
- "required": true,
1334
- "description": "unique id to identify the closing reason."
1335
- }
1336
- ],
1337
- "responses": {
1338
- "200": {
1339
- "description": "Returns the closing reason",
1340
- "content": {
1341
- "application/json": {
1342
- "schema": {
1343
- "$ref": "#/components/schemas/ClosingReason"
1344
- }
1345
- }
1346
- }
1347
- },
1348
- "400": {
1349
- "description": "Validation Errors",
1350
- "content": {
1351
- "application/json": {
1352
- "schema": {
1353
- "$ref": "#/components/schemas/ErrorResp"
1354
- }
1355
- }
1356
- }
1357
- },
1358
- "403": {
1359
- "description": "Forbidden",
1360
- "content": {
1361
- "application/json": {
1362
- "schema": {
1363
- "$ref": "#/components/schemas/ErrorResp"
1364
- }
1365
- }
1366
- }
1367
- },
1368
- "404": {
1369
- "description": "Closing reason not found",
1370
- "content": {
1371
- "application/json": {
1372
- "schema": {
1373
- "$ref": "#/components/schemas/ClosingReasonNotFoundResp"
1374
- }
1375
- }
1376
- }
1377
- }
1378
- }
1379
- },
1380
- "patch": {
1381
- "operationId": "updateClosingReason",
1382
- "summary": "updateClosingReason",
1383
- "description": "Update an existing closing reason",
1384
- "tags": [
1385
- "Closing Reason"
1386
- ],
1387
- "parameters": [
1388
- {
1389
- "in": "path",
1390
- "name": "reasonId",
1391
- "schema": {
1392
- "type": "string",
1393
- "example": "x739cew"
1394
- },
1395
- "required": true,
1396
- "description": "unique id to identify the closing reason."
1397
- }
1398
- ],
1399
- "requestBody": {
1400
- "description": "Updated closing reason fields",
1401
- "required": true,
1402
- "content": {
1403
- "application/json": {
1404
- "schema": {
1405
- "$ref": "#/components/schemas/ClosingReason"
1406
- }
1407
- }
1408
- }
1409
- },
1410
- "responses": {
1411
- "200": {
1412
- "description": "Closing reason updated successfully",
1413
- "content": {
1414
- "application/json": {
1415
- "schema": {
1416
- "$ref": "#/components/schemas/ClosingReason"
1417
- }
1418
- }
1419
- }
1420
- },
1421
- "400": {
1422
- "description": "Validation Errors",
1423
- "content": {
1424
- "application/json": {
1425
- "schema": {
1426
- "$ref": "#/components/schemas/ErrorResp"
1427
- }
1428
- }
1429
- }
1430
- },
1431
- "403": {
1432
- "description": "Forbidden",
1433
- "content": {
1434
- "application/json": {
1435
- "schema": {
1436
- "$ref": "#/components/schemas/ErrorResp"
1437
- }
1438
- }
1439
- }
1440
- },
1441
- "404": {
1442
- "description": "Closing reason not found",
1443
- "content": {
1444
- "application/json": {
1445
- "schema": {
1446
- "$ref": "#/components/schemas/ClosingReasonNotFoundResp"
1447
- }
1448
- }
1449
- }
1450
- }
1451
- }
1452
- },
1453
- "delete": {
1454
- "operationId": "deleteClosingReason",
1455
- "summary": "deleteClosingReason",
1456
- "description": "Permanently delete a closing reason (Using INACTIVE status is recommended instead)",
1457
- "tags": [
1458
- "Closing Reason"
1459
- ],
1460
- "parameters": [
1461
- {
1462
- "in": "path",
1463
- "name": "reasonId",
1464
- "schema": {
1465
- "type": "string",
1466
- "example": "x739cew"
1467
- },
1468
- "required": true,
1469
- "description": "unique id to identify the closing reason."
1470
- }
1471
- ],
1472
- "responses": {
1473
- "204": {
1474
- "description": "Closing reason deleted successfully"
1475
- },
1476
- "403": {
1477
- "description": "Forbidden",
1478
- "content": {
1479
- "application/json": {
1480
- "schema": {
1481
- "$ref": "#/components/schemas/ErrorResp"
1482
- }
1483
- }
1484
- }
1485
- },
1486
- "404": {
1487
- "description": "Closing reason not found",
1488
- "content": {
1489
- "application/json": {
1490
- "schema": {
1491
- "$ref": "#/components/schemas/ClosingReasonNotFoundResp"
1492
- }
1493
- }
1494
- }
1495
- }
1496
- }
1497
- }
1498
- },
1499
- "/v1/workflows/closing-reasons/{reasonId}": {
1500
- "get": {
1501
- "deprecated": true,
1502
- "operationId": "getClosingReasonV1",
1503
- "summary": "getClosingReasonV1",
1504
- "description": "Get specific closing reason by id from the organisation.",
1505
- "tags": [
1506
- "Closing Reason"
1507
- ],
1508
- "parameters": [
1509
- {
1510
- "in": "path",
1511
- "name": "reasonId",
1512
- "schema": {
1513
- "type": "string"
1514
- },
1515
- "required": true,
1516
- "description": "uuid to identify the closing reason.",
1517
- "example": "-poOAPBa-jFZA_AWV3zN0"
1518
- }
1519
- ],
1520
- "responses": {
1521
- "200": {
1522
- "description": "Returns the closing reason",
1523
- "content": {
1524
- "application/json": {
1525
- "schema": {
1526
- "$ref": "#/components/schemas/ClosingReason"
1527
- },
1528
- "example": {
1529
- "id": "-poOAPBa-jFZA_AWV3zN0",
1530
- "title": "Closing due to example reason",
1531
- "status": "ACTIVE",
1532
- "lastUpdateTime": "2021-08-04T21:13:50.373Z",
1533
- "creationTime": "2021-08-04T21:13:50.373Z"
1534
- }
1535
- }
1536
- }
1537
- },
1538
- "400": {
1539
- "description": "Validation Errors",
1540
- "content": {
1541
- "application/json": {
1542
- "schema": {
1543
- "$ref": "#/components/schemas/ErrorResp"
1544
- }
1545
- }
1546
- }
1547
- },
1548
- "401": {
1549
- "description": "Authentication Errors",
1550
- "content": {
1551
- "application/json": {
1552
- "schema": {
1553
- "$ref": "#/components/schemas/ErrorResp"
1554
- }
1555
- }
1556
- }
1557
- },
1558
- "404": {
1559
- "description": "Closing reason not found",
1560
- "content": {
1561
- "application/json": {
1562
- "schema": {
1563
- "$ref": "#/components/schemas/ClosingReasonNotFoundResp"
1564
- }
1565
- }
1566
- }
1567
- },
1568
- "500": {
1569
- "description": "Other errors",
1570
- "content": {
1571
- "application/json": {
1572
- "schema": {
1573
- "$ref": "#/components/schemas/ErrorResp"
1574
- }
1575
- }
1576
- }
1577
- }
1578
- }
1579
- },
1580
- "patch": {
1581
- "operationId": "changeReasonStatus",
1582
- "summary": "changeReasonStatus",
1583
- "description": "Change the status of a Closing Reason (eg. ACTIVE to INACTIVE).",
1584
- "tags": [
1585
- "Closing Reason"
1586
- ],
1587
- "parameters": [
1588
- {
1589
- "in": "path",
1590
- "name": "reasonId",
1591
- "required": true,
1592
- "schema": {
1593
- "type": "string"
1594
- }
1595
- }
1596
- ],
1597
- "requestBody": {
1598
- "description": "change the status of a closing reason",
1599
- "content": {
1600
- "application/json": {
1601
- "schema": {
1602
- "$ref": "#/components/schemas/ChangeReasonStatusReq"
1603
- }
1604
- }
1605
- }
1606
- },
1607
- "responses": {
1608
- "202": {
1609
- "description": "The status change was accepted"
1610
- },
1611
- "400": {
1612
- "description": "bad request",
1613
- "content": {
1614
- "application/json": {
1615
- "schema": {
1616
- "$ref": "#/components/schemas/ErrorResp"
1617
- }
1618
- }
1619
- }
1620
- },
1621
- "500": {
1622
- "description": "Internal server error",
1623
- "content": {
1624
- "application/json": {
1625
- "schema": {
1626
- "$ref": "#/components/schemas/ErrorResp"
1627
- }
1628
- }
1629
- }
1630
- }
1631
- }
1632
- }
1633
- },
1634
- "/v1/workflows/definitions/{definitionId}/closing-reasons": {
1635
- "get": {
1636
- "operationId": "getWorkflowClosingReasons",
1637
- "summary": "getWorkflowClosingReasons",
1638
- "description": "Returns all closing reasons defined for the workflow.",
1639
- "parameters": [
1640
- {
1641
- "in": "path",
1642
- "name": "definitionId",
1643
- "schema": {
1644
- "type": "string"
1645
- },
1646
- "required": true,
1647
- "description": "ID of a workflow definition",
1648
- "example": "fxcwfw"
1649
- }
1650
- ],
1651
- "tags": [
1652
- "Workflows"
1653
- ],
1654
- "responses": {
1655
- "200": {
1656
- "description": "Returns the entire catalog of closing reasons for a specific workflow",
1657
- "content": {
1658
- "application/json": {
1659
- "schema": {
1660
- "$ref": "#/components/schemas/ClosingReasonsIds"
1661
- }
1662
- }
1663
- }
1664
- }
1665
- }
1666
- },
1667
- "patch": {
1668
- "operationId": "setWorkflowClosingReasons",
1669
- "summary": "setWorkflowClosingReasons",
1670
- "description": "Sets which closing reasons are defined for this workflow, based on the entire closing reasons catalog.",
1671
- "tags": [
1672
- "Workflows"
1673
- ],
1674
- "parameters": [
1675
- {
1676
- "in": "path",
1677
- "name": "definitionId",
1678
- "schema": {
1679
- "type": "string"
1680
- },
1681
- "required": true,
1682
- "description": "ID of a workflow definition",
1683
- "example": 7889
1684
- }
1685
- ],
1686
- "requestBody": {
1687
- "description": "set all closing reasons for a specific definition",
1688
- "required": true,
1689
- "content": {
1690
- "application/json": {
1691
- "schema": {
1692
- "$ref": "#/components/schemas/ClosingReasonsIds"
1693
- }
1694
- }
1695
- }
1696
- },
1697
- "responses": {
1698
- "201": {
1699
- "description": "closing reasons are set for this workflow"
1700
- }
1701
- }
1702
- }
1703
- }
1704
- },
1705
- "components": {
1706
- "securitySchemes": {
1707
- "BearerAuth": {
1708
- "type": "http",
1709
- "scheme": "bearer",
1710
- "bearerFormat": "JWT"
1711
- }
1712
- },
1713
- "schemas": {
1714
- "FlowTemplateBase": {
1715
- "type": "object",
1716
- "required": [
1717
- "name",
1718
- "tasks",
1719
- "edges"
1720
- ],
1721
- "properties": {
1722
- "id": {
1723
- "type": "string"
1724
- },
1725
- "org_id": {
1726
- "type": "string"
1727
- },
1728
- "name": {
1729
- "type": "string"
1730
- },
1731
- "description": {
1732
- "type": "string"
1733
- },
1734
- "trigger": {
1735
- "$ref": "#/components/schemas/Trigger"
1736
- },
1737
- "enabled": {
1738
- "type": "boolean",
1739
- "description": "Whether the workflow is enabled or not",
1740
- "default": true
1741
- },
1742
- "version": {
1743
- "$ref": "#/components/schemas/Version"
1744
- },
1745
- "created_at": {
1746
- "type": "string",
1747
- "description": "ISO String Date & Time",
1748
- "example": "2021-04-27T12:01:13.000Z"
1749
- },
1750
- "updated_at": {
1751
- "type": "string",
1752
- "description": "ISO String Date & Time",
1753
- "example": "2021-04-27T12:01:13.000Z"
1754
- },
1755
- "due_date": {
1756
- "type": "string",
1757
- "example": "2021-04-27T12:00:00.000Z"
1758
- },
1759
- "due_date_config": {
1760
- "$ref": "#/components/schemas/DueDateConfig"
1761
- },
1762
- "assigned_to": {
1763
- "type": "array",
1764
- "items": {
1765
- "oneOf": [
1766
- {
1767
- "type": "string"
1768
- },
1769
- {
1770
- "$ref": "#/components/schemas/VariableAssignment"
1771
- }
1772
- ]
1773
- }
1774
- },
1775
- "available_in_ecp": {
1776
- "type": "boolean",
1777
- "description": "Indicates whether this workflow is available for End Customer Portal or not. By default it's not."
1778
- },
1779
- "additional_triggers": {
1780
- "type": "array",
1781
- "description": "Additional trigger configurations that can also start this flow. Useful for flows that should be startable via multiple methods (e.g., both automation AND manual).",
1782
- "items": {
1783
- "$ref": "#/components/schemas/Trigger"
1784
- }
1785
- },
1786
- "phases": {
1787
- "type": "array",
1788
- "items": {
1789
- "$ref": "#/components/schemas/Phase"
1790
- }
1791
- },
1792
- "tasks": {
1793
- "type": "array",
1794
- "items": {
1795
- "$ref": "#/components/schemas/Task"
1796
- }
1797
- },
1798
- "edges": {
1799
- "type": "array",
1800
- "items": {
1801
- "$ref": "#/components/schemas/Edge"
1802
- }
1803
- },
1804
- "closing_reasons": {
1805
- "type": "array",
1806
- "items": {
1807
- "$ref": "#/components/schemas/ClosingReason"
1808
- }
1809
- },
1810
- "entity_sync": {
1811
- "type": "array",
1812
- "items": {
1813
- "$ref": "#/components/schemas/EntitySync"
1814
- }
1815
- },
1816
- "taxonomies": {
1817
- "type": "array",
1818
- "items": {
1819
- "type": "string"
1820
- },
1821
- "description": "Taxonomy ids that are associated with this workflow and used for filtering"
1822
- },
1823
- "singleClosingReasonSelection": {
1824
- "type": "boolean",
1825
- "description": "Whether only a single closing reason can be selected"
1826
- }
1827
- }
1828
- },
1829
- "FlowTemplate": {
1830
- "allOf": [
1831
- {
1832
- "$ref": "#/components/schemas/FlowTemplateBase"
1833
- },
1834
- {
1835
- "type": "object",
1836
- "properties": {
1837
- "closing_reasons": {
1838
- "type": "array",
1839
- "items": {
1840
- "$ref": "#/components/schemas/ClosingReason"
1841
- }
1842
- }
1843
- }
1844
- }
1845
- ]
1846
- },
1847
- "Version": {
1848
- "type": "string",
1849
- "enum": [
1850
- "v1",
1851
- "v2",
1852
- "v3"
1853
- ],
1854
- "description": "Version of the workflow schema.\n\n- `v1` – *Deprecated*. The initial version of workflows with limited structure and automation capabilities. \n- `v2` – Linear workflows. Supports sequential task execution with basic automation triggers. \n- `v3` – Advanced workflows. Adds support for branching logic (conditions), parallel paths, and enhanced automation features such as dynamic triggers and flow control.\n",
1855
- "example": 2
1856
- },
1857
- "Trigger": {
1858
- "anyOf": [
1859
- {
1860
- "$ref": "#/components/schemas/ManualTrigger"
1861
- },
1862
- {
1863
- "$ref": "#/components/schemas/AutomationTrigger"
1864
- },
1865
- {
1866
- "$ref": "#/components/schemas/JourneySubmissionTrigger"
1867
- },
1868
- {
1869
- "$ref": "#/components/schemas/JourneyAutomationTrigger"
1870
- }
1871
- ],
1872
- "example": {
1873
- "type": "automation",
1874
- "automation_id": "g92j2-sg9ug92hjt1gh-9s9gajgs-a979gg"
1875
- }
1876
- },
1877
- "ManualTrigger": {
1878
- "type": "object",
1879
- "required": [
1880
- "type"
1881
- ],
1882
- "properties": {
1883
- "id": {
1884
- "type": "string"
1885
- },
1886
- "type": {
1887
- "type": "string",
1888
- "enum": [
1889
- "manual"
1890
- ]
1891
- },
1892
- "entity_schema": {
1893
- "type": "string"
1894
- }
1895
- }
1896
- },
1897
- "AutomationTrigger": {
1898
- "type": "object",
1899
- "required": [
1900
- "type"
1901
- ],
1902
- "properties": {
1903
- "id": {
1904
- "type": "string"
1905
- },
1906
- "type": {
1907
- "type": "string",
1908
- "enum": [
1909
- "automation"
1910
- ]
1911
- },
1912
- "automation_id": {
1913
- "type": "string",
1914
- "description": "Id of the automation config that triggers this workflow"
1915
- },
1916
- "trigger_config": {
1917
- "type": "array",
1918
- "items": {
1919
- "type": "object",
1920
- "required": [
1921
- "type"
1922
- ],
1923
- "properties": {
1924
- "type": {
1925
- "type": "string",
1926
- "description": "The trigger type (e.g. entity_operation, activity)"
1927
- },
1928
- "configuration": {
1929
- "type": "object",
1930
- "additionalProperties": true,
1931
- "description": "Trigger-specific configuration"
1932
- }
1933
- },
1934
- "additionalProperties": true
1935
- },
1936
- "description": "Transient field. Trigger configurations for creating or updating the trigger automation flow. Each item follows the automation API trigger schema. Processed by the backend during create/update and stripped before storage.\n"
1937
- }
1938
- }
1939
- },
1940
- "JourneyAutomationTrigger": {
1941
- "type": "object",
1942
- "required": [
1943
- "type"
1944
- ],
1945
- "properties": {
1946
- "id": {
1947
- "type": "string"
1948
- },
1949
- "type": {
1950
- "type": "string",
1951
- "enum": [
1952
- "journey_automation"
1953
- ]
1954
- },
1955
- "entity_schema": {
1956
- "type": "string",
1957
- "description": "Schema of the main entity where flow will be triggered. The entity will be picked from automation context."
1958
- }
1959
- }
1960
- },
1961
- "JourneySubmissionTrigger": {
1962
- "type": "object",
1963
- "required": [
1964
- "type",
1965
- "journey_id"
1966
- ],
1967
- "properties": {
1968
- "id": {
1969
- "type": "string"
1970
- },
1971
- "type": {
1972
- "type": "string",
1973
- "enum": [
1974
- "journey_submission"
1975
- ]
1976
- },
1977
- "journey_id": {
1978
- "type": "string",
1979
- "description": "ID of the journey that will trigger this flow"
1980
- },
1981
- "journey_name": {
1982
- "type": "string",
1983
- "description": "Name of the journey that will trigger this flow"
1984
- },
1985
- "automation_id": {
1986
- "type": "string"
1987
- }
1988
- }
1989
- },
1990
- "CreateFlowTemplate": {
1991
- "allOf": [
1992
- {
1993
- "$ref": "#/components/schemas/FlowTemplateBase"
1994
- },
1995
- {
1996
- "type": "object",
1997
- "properties": {
1998
- "closing_reasons": {
1999
- "type": "array",
2000
- "items": {
2001
- "type": "object",
2002
- "required": [
2003
- "id"
2004
- ],
2005
- "properties": {
2006
- "id": {
2007
- "type": "string"
2008
- }
2009
- }
2010
- }
2011
- }
2012
- }
2013
- }
2014
- ]
2015
- },
2016
- "SearchFlowTemplates": {
2017
- "type": "object",
2018
- "properties": {
2019
- "name": {
2020
- "type": "string"
2021
- },
2022
- "definition_id": {
2023
- "type": "string"
2024
- },
2025
- "trigger_type": {
2026
- "type": "string",
2027
- "enum": [
2028
- "journey_submission",
2029
- "manual",
2030
- "automation"
2031
- ]
2032
- },
2033
- "enabled": {
2034
- "type": "boolean"
2035
- },
2036
- "from": {
2037
- "type": "integer"
2038
- },
2039
- "size": {
2040
- "type": "integer"
2041
- },
2042
- "sort_by": {
2043
- "type": "string",
2044
- "enum": [
2045
- "created_at",
2046
- "updated_at"
2047
- ],
2048
- "default": "updated_at"
2049
- },
2050
- "sort_order": {
2051
- "type": "string",
2052
- "enum": [
2053
- "asc",
2054
- "desc"
2055
- ],
2056
- "default": "desc"
2057
- }
2058
- }
2059
- },
2060
- "FlowTemplatesList": {
2061
- "type": "object",
2062
- "properties": {
2063
- "results": {
2064
- "type": "array",
2065
- "items": {
2066
- "$ref": "#/components/schemas/FlowTemplate"
2067
- }
2068
- }
2069
- },
2070
- "required": [
2071
- "results"
2072
- ]
2073
- },
2074
- "FlowTemplateId": {
2075
- "type": "string",
2076
- "description": "Short unique id (length 8) to identify the Flow Template.",
2077
- "example": "7hj28akg"
2078
- },
2079
- "Task": {
2080
- "anyOf": [
2081
- {
2082
- "$ref": "#/components/schemas/ManualTask"
2083
- },
2084
- {
2085
- "$ref": "#/components/schemas/AutomationTask"
2086
- },
2087
- {
2088
- "$ref": "#/components/schemas/DecisionTask"
2089
- },
2090
- {
2091
- "$ref": "#/components/schemas/AiAgentTask"
2092
- }
2093
- ]
2094
- },
2095
- "ManualTask": {
2096
- "allOf": [
2097
- {
2098
- "$ref": "#/components/schemas/TaskBase"
2099
- }
2100
- ]
2101
- },
2102
- "AutomationTask": {
2103
- "allOf": [
2104
- {
2105
- "$ref": "#/components/schemas/TaskBase"
2106
- },
2107
- {
2108
- "type": "object",
2109
- "required": [
2110
- "automation_config"
2111
- ],
2112
- "properties": {
2113
- "automation_config": {
2114
- "$ref": "#/components/schemas/AutomationConfig"
2115
- },
2116
- "trigger_mode": {
2117
- "$ref": "#/components/schemas/TriggerMode"
2118
- },
2119
- "schedule": {
2120
- "$ref": "#/components/schemas/ActionSchedule"
2121
- },
2122
- "created_automatically": {
2123
- "type": "boolean",
2124
- "description": "Indicates whether this task was created automatically by journeys or manually by an user",
2125
- "default": false
2126
- }
2127
- }
2128
- }
2129
- ]
2130
- },
2131
- "AutomationConfig": {
2132
- "type": "object",
2133
- "description": "Configuration for automation execution to run",
2134
- "properties": {
2135
- "flow_id": {
2136
- "type": "string",
2137
- "description": "Id of the configured automation to run"
2138
- },
2139
- "action_config": {
2140
- "type": "object",
2141
- "required": [
2142
- "type"
2143
- ],
2144
- "properties": {
2145
- "type": {
2146
- "type": "string",
2147
- "description": "The action type (e.g. send-email, trigger-workflow)"
2148
- },
2149
- "config": {
2150
- "type": "object",
2151
- "additionalProperties": true,
2152
- "description": "Action-specific configuration"
2153
- }
2154
- },
2155
- "additionalProperties": true,
2156
- "description": "Transient field. The full automation action configuration following the automation API action schema. Processed by the backend during create/update and stripped before storage. When present without a flow_id, a new automation flow is created. When present with a flow_id, the existing automation flow is updated.\n"
2157
- }
2158
- }
2159
- },
2160
- "AiAgentTask": {
2161
- "allOf": [
2162
- {
2163
- "$ref": "#/components/schemas/TaskBase"
2164
- },
2165
- {
2166
- "type": "object",
2167
- "properties": {
2168
- "agent_config": {
2169
- "$ref": "#/components/schemas/AgentConfig"
2170
- }
2171
- }
2172
- }
2173
- ]
2174
- },
2175
- "AgentConfig": {
2176
- "type": "object",
2177
- "description": "Configuration for AI Agent to run",
2178
- "required": [
2179
- "agent_id"
2180
- ],
2181
- "properties": {
2182
- "agent_id": {
2183
- "type": "string",
2184
- "description": "Id of the configured AI Agent to run"
2185
- }
2186
- },
2187
- "additionalProperties": true
2188
- },
2189
- "TriggerMode": {
2190
- "type": "string",
2191
- "enum": [
2192
- "manual",
2193
- "automatic"
2194
- ]
2195
- },
2196
- "ActionSchedule": {
2197
- "anyOf": [
2198
- {
2199
- "$ref": "#/components/schemas/ImmediateSchedule"
2200
- },
2201
- {
2202
- "$ref": "#/components/schemas/DelayedSchedule"
2203
- },
2204
- {
2205
- "$ref": "#/components/schemas/RelativeSchedule"
2206
- }
2207
- ]
2208
- },
2209
- "ImmediateSchedule": {
2210
- "type": "object",
2211
- "properties": {
2212
- "mode": {
2213
- "enum": [
2214
- "immediate"
2215
- ]
2216
- }
2217
- }
2218
- },
2219
- "DelayedSchedule": {
2220
- "type": "object",
2221
- "required": [
2222
- "mode",
2223
- "duration",
2224
- "unit"
2225
- ],
2226
- "properties": {
2227
- "mode": {
2228
- "enum": [
2229
- "delayed"
2230
- ]
2231
- },
2232
- "duration": {
2233
- "type": "number"
2234
- },
2235
- "unit": {
2236
- "$ref": "#/components/schemas/TimeUnit"
2237
- }
2238
- }
2239
- },
2240
- "RelativeSchedule": {
2241
- "type": "object",
2242
- "properties": {
2243
- "mode": {
2244
- "enum": [
2245
- "relative"
2246
- ]
2247
- },
2248
- "direction": {
2249
- "type": "string",
2250
- "enum": [
2251
- "before",
2252
- "after"
2253
- ]
2254
- },
2255
- "duration": {
2256
- "type": "number"
2257
- },
2258
- "unit": {
2259
- "$ref": "#/components/schemas/TimeUnit"
2260
- },
2261
- "reference": {
2262
- "type": "object",
2263
- "required": [
2264
- "id",
2265
- "origin"
2266
- ],
2267
- "properties": {
2268
- "id": {
2269
- "type": "string",
2270
- "description": "The id of the entity / workflow / task, based on the origin of the schedule"
2271
- },
2272
- "origin": {
2273
- "type": "string",
2274
- "enum": [
2275
- "flow_started",
2276
- "task_completed",
2277
- "trigger_entity_attribute"
2278
- ]
2279
- },
2280
- "schema": {
2281
- "type": "string",
2282
- "description": "The schema of the entity"
2283
- },
2284
- "attribute": {
2285
- "type": "string",
2286
- "description": "An entity attribute that identifies a date / datetime"
2287
- }
2288
- }
2289
- }
2290
- },
2291
- "required": [
2292
- "mode",
2293
- "direction",
2294
- "duration",
2295
- "unit",
2296
- "reference"
2297
- ]
2298
- },
2299
- "DecisionTask": {
2300
- "allOf": [
2301
- {
2302
- "$ref": "#/components/schemas/TaskBase"
2303
- },
2304
- {
2305
- "type": "object",
2306
- "properties": {
2307
- "trigger_mode": {
2308
- "$ref": "#/components/schemas/TriggerMode"
2309
- },
2310
- "conditions": {
2311
- "type": "array",
2312
- "items": {
2313
- "$ref": "#/components/schemas/Condition"
2314
- }
2315
- },
2316
- "schedule": {
2317
- "anyOf": [
2318
- {
2319
- "$ref": "#/components/schemas/DelayedSchedule"
2320
- },
2321
- {
2322
- "$ref": "#/components/schemas/RelativeSchedule"
2323
- }
2324
- ]
2325
- },
2326
- "loop_config": {
2327
- "type": "object",
2328
- "properties": {
2329
- "loop_branch_id": {
2330
- "type": "string",
2331
- "description": "The id of the branch that will be looped"
2332
- },
2333
- "exit_branch_id": {
2334
- "type": "string",
2335
- "description": "The id of the branch that will be used to exit the loop"
2336
- },
2337
- "max_iterations": {
2338
- "type": "integer",
2339
- "description": "Maximum number of iterations for the loop branch",
2340
- "default": 3,
2341
- "minimum": 1,
2342
- "maximum": 10
2343
- }
2344
- },
2345
- "required": [
2346
- "loop_branch_id",
2347
- "exit_branch_id",
2348
- "max_iterations"
2349
- ]
2350
- }
2351
- },
2352
- "required": [
2353
- "trigger_mode",
2354
- "conditions"
2355
- ]
2356
- }
2357
- ]
2358
- },
2359
- "TaskBase": {
2360
- "type": "object",
2361
- "properties": {
2362
- "id": {
2363
- "type": "string"
2364
- },
2365
- "name": {
2366
- "type": "string"
2367
- },
2368
- "description": {
2369
- "$ref": "#/components/schemas/StepDescription"
2370
- },
2371
- "journey": {
2372
- "$ref": "#/components/schemas/StepJourney"
2373
- },
2374
- "due_date": {
2375
- "type": "string",
2376
- "example": "2021-04-27T12:00:00.000Z"
2377
- },
2378
- "due_date_config": {
2379
- "$ref": "#/components/schemas/DueDateConfig"
2380
- },
2381
- "requirements": {
2382
- "type": "array",
2383
- "description": "requirements that need to be fulfilled in order to enable the task while flow instances are running",
2384
- "items": {
2385
- "$ref": "#/components/schemas/EnableRequirement"
2386
- }
2387
- },
2388
- "assigned_to": {
2389
- "type": "array",
2390
- "items": {
2391
- "oneOf": [
2392
- {
2393
- "type": "string"
2394
- },
2395
- {
2396
- "$ref": "#/components/schemas/VariableAssignment"
2397
- }
2398
- ]
2399
- }
2400
- },
2401
- "ecp": {
2402
- "$ref": "#/components/schemas/ECPDetails"
2403
- },
2404
- "installer": {
2405
- "$ref": "#/components/schemas/ECPDetails"
2406
- },
2407
- "taxonomies": {
2408
- "type": "array",
2409
- "items": {
2410
- "type": "string"
2411
- },
2412
- "description": "Taxonomy ids that are associated with this workflow and used for filtering"
2413
- },
2414
- "phase_id": {
2415
- "type": "string"
2416
- },
2417
- "task_type": {
2418
- "$ref": "#/components/schemas/TaskType"
2419
- }
2420
- },
2421
- "required": [
2422
- "id",
2423
- "name",
2424
- "task_type"
2425
- ]
2426
- },
2427
- "Phase": {
2428
- "type": "object",
2429
- "properties": {
2430
- "id": {
2431
- "type": "string"
2432
- },
2433
- "name": {
2434
- "type": "string"
2435
- },
2436
- "due_date": {
2437
- "type": "string",
2438
- "example": "2021-04-27T12:00:00.000Z"
2439
- },
2440
- "due_date_config": {
2441
- "$ref": "#/components/schemas/DueDateConfig"
2442
- },
2443
- "assigned_to": {
2444
- "type": "array",
2445
- "items": {
2446
- "oneOf": [
2447
- {
2448
- "type": "string"
2449
- },
2450
- {
2451
- "$ref": "#/components/schemas/VariableAssignment"
2452
- }
2453
- ]
2454
- }
2455
- },
2456
- "taxonomies": {
2457
- "type": "array",
2458
- "items": {
2459
- "type": "string"
2460
- },
2461
- "description": "Taxonomy ids that are associated with this workflow and used for filtering"
2462
- }
2463
- },
2464
- "required": [
2465
- "id",
2466
- "name"
2467
- ]
2468
- },
2469
- "VariableAssignment": {
2470
- "type": "object",
2471
- "description": "Represents a variable assignment with its expression and optional resolved value. Used for dynamic user assignments that get resolved during workflow execution.",
2472
- "properties": {
2473
- "variable": {
2474
- "type": "string",
2475
- "description": "The variable expression, e.g., \"{{entity.owner}}\"",
2476
- "example": "{{entity.owner}}"
2477
- },
2478
- "value": {
2479
- "type": "string",
2480
- "description": "The resolved value after variable evaluation (populated during execution)",
2481
- "example": "user_12345"
2482
- }
2483
- },
2484
- "required": [
2485
- "variable"
2486
- ]
2487
- },
2488
- "TaskType": {
2489
- "type": "string",
2490
- "enum": [
2491
- "MANUAL",
2492
- "AUTOMATION",
2493
- "DECISION",
2494
- "AI_AGENT"
2495
- ]
2496
- },
2497
- "Edge": {
2498
- "type": "object",
2499
- "properties": {
2500
- "id": {
2501
- "type": "string"
2502
- },
2503
- "from_id": {
2504
- "type": "string"
2505
- },
2506
- "to_id": {
2507
- "type": "string"
2508
- },
2509
- "condition_id": {
2510
- "type": "string"
2511
- },
2512
- "none_met": {
2513
- "type": "boolean",
2514
- "description": "Indicates a default case for a decision task. Only decision task edges can have this field and the flow advances using this edge if no conditions are met."
2515
- }
2516
- },
2517
- "required": [
2518
- "id",
2519
- "from_id",
2520
- "to_id"
2521
- ]
2522
- },
2523
- "Condition": {
2524
- "type": "object",
2525
- "properties": {
2526
- "id": {
2527
- "type": "string"
2528
- },
2529
- "branch_name": {
2530
- "type": "string",
2531
- "description": "The name of the branch",
2532
- "maxLength": 255,
2533
- "example": "Branch 1"
2534
- },
2535
- "logical_operator": {
2536
- "type": "string",
2537
- "enum": [
2538
- "AND",
2539
- "OR"
2540
- ]
2541
- },
2542
- "statements": {
2543
- "type": "array",
2544
- "items": {
2545
- "$ref": "#/components/schemas/Statement"
2546
- }
2547
- }
2548
- },
2549
- "required": [
2550
- "id",
2551
- "branch_name",
2552
- "logical_operator",
2553
- "statements"
2554
- ]
2555
- },
2556
- "Statement": {
2557
- "type": "object",
2558
- "properties": {
2559
- "id": {
2560
- "type": "string"
2561
- },
2562
- "source": {
2563
- "$ref": "#/components/schemas/EvaluationSource"
2564
- },
2565
- "operator": {
2566
- "$ref": "#/components/schemas/Operator"
2567
- },
2568
- "values": {
2569
- "type": "array",
2570
- "items": {
2571
- "type": "string"
2572
- }
2573
- }
2574
- },
2575
- "required": [
2576
- "id",
2577
- "source",
2578
- "operator",
2579
- "values"
2580
- ]
2581
- },
2582
- "EvaluationSource": {
2583
- "type": "object",
2584
- "properties": {
2585
- "id": {
2586
- "type": "string",
2587
- "description": "The id of the action or trigger"
2588
- },
2589
- "origin": {
2590
- "type": "string",
2591
- "enum": [
2592
- "trigger",
2593
- "action"
2594
- ]
2595
- },
2596
- "origin_type": {
2597
- "type": "string",
2598
- "enum": [
2599
- "entity",
2600
- "workflow",
2601
- "journey_block"
2602
- ]
2603
- },
2604
- "schema": {
2605
- "type": "string"
2606
- },
2607
- "attribute": {
2608
- "type": "string"
2609
- },
2610
- "attribute_type": {
2611
- "type": "string",
2612
- "enum": [
2613
- "string",
2614
- "text",
2615
- "number",
2616
- "boolean",
2617
- "date",
2618
- "datetime",
2619
- "tags",
2620
- "country",
2621
- "email",
2622
- "phone",
2623
- "product",
2624
- "price",
2625
- "status",
2626
- "relation",
2627
- "multiselect",
2628
- "select",
2629
- "radio",
2630
- "relation_user",
2631
- "purpose",
2632
- "label",
2633
- "message_email_address"
2634
- ]
2635
- },
2636
- "attribute_repeatable": {
2637
- "type": "boolean"
2638
- },
2639
- "attribute_operation": {
2640
- "enum": [
2641
- "all",
2642
- "updated",
2643
- "added",
2644
- "deleted"
2645
- ]
2646
- },
2647
- "attribute_sub_field": {
2648
- "type": "string",
2649
- "description": "For complex attribute types, specifies which sub-field to extract (e.g., 'address', 'name', 'email_type')"
2650
- }
2651
- }
2652
- },
2653
- "Operator": {
2654
- "type": "string",
2655
- "enum": [
2656
- "equals",
2657
- "not_equals",
2658
- "any_of",
2659
- "none_of",
2660
- "contains",
2661
- "not_contains",
2662
- "starts_with",
2663
- "ends_with",
2664
- "greater_than",
2665
- "less_than",
2666
- "greater_than_or_equals",
2667
- "less_than_or_equals",
2668
- "is_empty",
2669
- "is_not_empty"
2670
- ]
2671
- },
2672
- "DueDateConfig": {
2673
- "description": "Set due date for the task based on a dynamic condition",
2674
- "type": "object",
2675
- "properties": {
2676
- "duration": {
2677
- "type": "number"
2678
- },
2679
- "unit": {
2680
- "$ref": "#/components/schemas/TimeUnit"
2681
- },
2682
- "type": {
2683
- "type": "string",
2684
- "enum": [
2685
- "WORKFLOW_STARTED",
2686
- "TASK_FINISHED",
2687
- "PHASE_FINISHED"
2688
- ]
2689
- },
2690
- "task_id": {
2691
- "type": "string"
2692
- },
2693
- "phase_id": {
2694
- "type": "string"
2695
- }
2696
- },
2697
- "required": [
2698
- "duration",
2699
- "unit",
2700
- "type"
2701
- ]
2702
- },
2703
- "TimeUnit": {
2704
- "type": "string",
2705
- "enum": [
2706
- "minutes",
2707
- "hours",
2708
- "days",
2709
- "weeks",
2710
- "months"
2711
- ]
2712
- },
2713
- "EnableRequirement": {
2714
- "description": "describe the requirement for a task to be enabled",
2715
- "type": "object",
2716
- "properties": {
2717
- "task_id": {
2718
- "type": "string",
2719
- "description": "The id of the task that it points to"
2720
- },
2721
- "phase_id": {
2722
- "type": "string",
2723
- "description": "The id of the phase that it points to"
2724
- },
2725
- "when": {
2726
- "type": "string",
2727
- "enum": [
2728
- "TASK_FINISHED",
2729
- "PHASE_FINISHED"
2730
- ]
2731
- }
2732
- },
2733
- "required": [
2734
- "when"
2735
- ]
2736
- },
2737
- "WorkflowDefinition": {
2738
- "type": "object",
2739
- "properties": {
2740
- "id": {
2741
- "type": "string"
2742
- },
2743
- "name": {
2744
- "type": "string"
2745
- },
2746
- "description": {
2747
- "type": "string"
2748
- },
2749
- "creationTime": {
2750
- "type": "string",
2751
- "description": "ISO String Date & Time",
2752
- "example": "2021-04-27T12:01:13.000Z"
2753
- },
2754
- "enabled": {
2755
- "type": "boolean",
2756
- "description": "Whether the workflow is enabled or not",
2757
- "default": true
2758
- },
2759
- "lastUpdateTime": {
2760
- "type": "string",
2761
- "description": "ISO String Date & Time",
2762
- "example": "2021-04-27T12:01:13.000Z"
2763
- },
2764
- "dueDate": {
2765
- "type": "string",
2766
- "example": "2021-04-27T12:00:00.000Z"
2767
- },
2768
- "dynamicDueDate": {
2769
- "$ref": "#/components/schemas/DynamicDueDate"
2770
- },
2771
- "userIds": {
2772
- "type": "array",
2773
- "items": {
2774
- "type": "number"
2775
- },
2776
- "deprecated": true,
2777
- "description": "This field is deprecated. Please use assignedTo"
2778
- },
2779
- "assignedTo": {
2780
- "type": "array",
2781
- "items": {
2782
- "type": "string"
2783
- }
2784
- },
2785
- "enableECPWorkflow": {
2786
- "type": "boolean",
2787
- "description": "Indicates whether this workflow is available for End Customer Portal or not. By default it's not."
2788
- },
2789
- "flow": {
2790
- "type": "array",
2791
- "items": {
2792
- "anyOf": [
2793
- {
2794
- "$ref": "#/components/schemas/Section"
2795
- },
2796
- {
2797
- "$ref": "#/components/schemas/Step"
2798
- }
2799
- ]
2800
- }
2801
- },
2802
- "closingReasons": {
2803
- "type": "array",
2804
- "items": {
2805
- "$ref": "#/components/schemas/ClosingReasonId"
2806
- }
2807
- },
2808
- "updateEntityAttributes": {
2809
- "type": "array",
2810
- "items": {
2811
- "$ref": "#/components/schemas/UpdateEntityAttributes"
2812
- }
2813
- },
2814
- "taxonomies": {
2815
- "type": "array",
2816
- "items": {
2817
- "type": "string"
2818
- },
2819
- "description": "Taxonomy ids that are associated with this workflow and used for filtering"
2820
- },
2821
- "singleClosingReasonSelection": {
2822
- "type": "boolean",
2823
- "description": "Whether only a single closing reason can be selected"
2824
- }
2825
- },
2826
- "required": [
2827
- "name",
2828
- "flow"
2829
- ]
2830
- },
2831
- "Step": {
2832
- "type": "object",
2833
- "description": "Action that needs to be done in a Workflow",
2834
- "properties": {
2835
- "id": {
2836
- "type": "string"
2837
- },
2838
- "name": {
2839
- "type": "string"
2840
- },
2841
- "description": {
2842
- "$ref": "#/components/schemas/StepDescription"
2843
- },
2844
- "executionType": {
2845
- "$ref": "#/components/schemas/StepType"
2846
- },
2847
- "automationConfig": {
2848
- "type": "object",
2849
- "properties": {
2850
- "flowId": {
2851
- "type": "string",
2852
- "description": "Id of the configured automation to run"
2853
- }
2854
- },
2855
- "required": [
2856
- "flowId"
2857
- ]
2858
- },
2859
- "journey": {
2860
- "$ref": "#/components/schemas/StepJourney"
2861
- },
2862
- "order": {
2863
- "type": "number"
2864
- },
2865
- "dueDate": {
2866
- "type": "string",
2867
- "example": "2021-04-27T12:00:00.000Z"
2868
- },
2869
- "dynamicDueDate": {
2870
- "$ref": "#/components/schemas/DynamicDueDate"
2871
- },
2872
- "userIds": {
2873
- "type": "array",
2874
- "items": {
2875
- "type": "number"
2876
- },
2877
- "deprecated": true,
2878
- "description": "This field is deprecated. Please use assignedTo"
2879
- },
2880
- "requirements": {
2881
- "type": "array",
2882
- "description": "requirements that need to be fulfilled in order to enable the step execution",
2883
- "items": {
2884
- "$ref": "#/components/schemas/StepRequirement"
2885
- }
2886
- },
2887
- "assignedTo": {
2888
- "type": "array",
2889
- "items": {
2890
- "type": "string"
2891
- }
2892
- },
2893
- "type": {
2894
- "$ref": "#/components/schemas/ItemType"
2895
- },
2896
- "ecp": {
2897
- "$ref": "#/components/schemas/ECPDetails"
2898
- },
2899
- "installer": {
2900
- "$ref": "#/components/schemas/ECPDetails"
2901
- },
2902
- "taxonomies": {
2903
- "type": "array",
2904
- "items": {
2905
- "type": "string"
2906
- },
2907
- "description": "Taxonomy ids that are associated with this workflow and used for filtering"
2908
- }
2909
- },
2910
- "required": [
2911
- "name",
2912
- "order",
2913
- "type"
2914
- ]
2915
- },
2916
- "Section": {
2917
- "type": "object",
2918
- "description": "A group of Steps that define the progress of the Workflow",
2919
- "properties": {
2920
- "id": {
2921
- "type": "string"
2922
- },
2923
- "name": {
2924
- "type": "string"
2925
- },
2926
- "order": {
2927
- "type": "number"
2928
- },
2929
- "type": {
2930
- "$ref": "#/components/schemas/ItemType"
2931
- },
2932
- "dueDate": {
2933
- "type": "string",
2934
- "example": "2021-04-27T12:00:00.000Z"
2935
- },
2936
- "dynamicDueDate": {
2937
- "$ref": "#/components/schemas/DynamicDueDate"
2938
- },
2939
- "assignedTo": {
2940
- "type": "array",
2941
- "items": {
2942
- "type": "string"
2943
- }
2944
- },
2945
- "steps": {
2946
- "type": "array",
2947
- "items": {
2948
- "$ref": "#/components/schemas/Step"
2949
- }
2950
- },
2951
- "taxonomies": {
2952
- "type": "array",
2953
- "items": {
2954
- "type": "string"
2955
- },
2956
- "description": "Taxonomy ids that are associated with this workflow and used for filtering"
2957
- }
2958
- },
2959
- "required": [
2960
- "name",
2961
- "order",
2962
- "type",
2963
- "steps"
2964
- ]
2965
- },
2966
- "TriggerType": {
2967
- "type": "string",
2968
- "enum": [
2969
- "MANUAL",
2970
- "AUTOMATIC"
2971
- ]
2972
- },
2973
- "ItemType": {
2974
- "type": "string",
2975
- "enum": [
2976
- "STEP",
2977
- "SECTION"
2978
- ]
2979
- },
2980
- "StepType": {
2981
- "type": "string",
2982
- "enum": [
2983
- "MANUAL",
2984
- "AUTOMATION"
2985
- ]
2986
- },
2987
- "StepJourney": {
2988
- "type": "object",
2989
- "properties": {
2990
- "id": {
2991
- "type": "string"
2992
- },
2993
- "journeyId": {
2994
- "type": "string"
2995
- },
2996
- "name": {
2997
- "type": "string"
2998
- },
2999
- "complete_task_automatically": {
3000
- "type": "boolean",
3001
- "default": true,
3002
- "description": "If true, the task be auto completed when the journey is completed. By default it is true."
3003
- }
3004
- }
3005
- },
3006
- "ECPDetails": {
3007
- "type": "object",
3008
- "description": "Details regarding ECP for the workflow step",
3009
- "properties": {
3010
- "enabled": {
3011
- "type": "boolean"
3012
- },
3013
- "label": {
3014
- "type": "string"
3015
- },
3016
- "description": {
3017
- "type": "string"
3018
- },
3019
- "journey": {
3020
- "$ref": "#/components/schemas/StepJourney"
3021
- }
3022
- }
3023
- },
3024
- "StepDescription": {
3025
- "type": "object",
3026
- "description": "Longer information regarding Task",
3027
- "properties": {
3028
- "enabled": {
3029
- "type": "boolean"
3030
- },
3031
- "value": {
3032
- "type": "string"
3033
- }
3034
- }
3035
- },
3036
- "MaxAllowedLimit": {
3037
- "type": "object",
3038
- "properties": {
3039
- "currentNoOfWorkflows": {
3040
- "type": "number"
3041
- },
3042
- "maxAllowed": {
3043
- "type": "number"
3044
- }
3045
- }
3046
- },
3047
- "DefinitionNotFoundResp": {
3048
- "description": "Definition could be not found",
3049
- "properties": {
3050
- "message": {
3051
- "type": "string"
3052
- }
3053
- }
3054
- },
3055
- "ClosingReasonNotFoundResp": {
3056
- "description": "Closing reason could be not found",
3057
- "properties": {
3058
- "message": {
3059
- "type": "string"
3060
- }
3061
- }
3062
- },
3063
- "ChangeReasonStatusReq": {
3064
- "type": "object",
3065
- "properties": {
3066
- "status": {
3067
- "$ref": "#/components/schemas/ClosingReasonsStatus"
3068
- }
3069
- },
3070
- "required": [
3071
- "status"
3072
- ]
3073
- },
3074
- "ClosingReasons": {
3075
- "type": "object",
3076
- "properties": {
3077
- "reasons": {
3078
- "type": "array",
3079
- "items": {
3080
- "$ref": "#/components/schemas/ClosingReason"
3081
- }
3082
- }
3083
- },
3084
- "required": [
3085
- "reasons"
3086
- ]
3087
- },
3088
- "ClosingReason": {
3089
- "type": "object",
3090
- "description": "One Closing reason for a workflow",
3091
- "required": [
3092
- "title",
3093
- "status"
3094
- ],
3095
- "properties": {
3096
- "id": {
3097
- "type": "string",
3098
- "readOnly": true
3099
- },
3100
- "title": {
3101
- "type": "string"
3102
- },
3103
- "status": {
3104
- "$ref": "#/components/schemas/ClosingReasonsStatus"
3105
- },
3106
- "lastUpdateTime": {
3107
- "type": "string",
3108
- "readOnly": true
3109
- },
3110
- "creationTime": {
3111
- "type": "string",
3112
- "readOnly": true
3113
- }
3114
- }
3115
- },
3116
- "ClosingReasonsStatus": {
3117
- "type": "string",
3118
- "enum": [
3119
- "ACTIVE",
3120
- "INACTIVE"
3121
- ]
3122
- },
3123
- "ClosingReasonsIds": {
3124
- "type": "object",
3125
- "properties": {
3126
- "reasons": {
3127
- "type": "array",
3128
- "items": {
3129
- "$ref": "#/components/schemas/ClosingReasonId"
3130
- }
3131
- }
3132
- },
3133
- "required": [
3134
- "reasons"
3135
- ]
3136
- },
3137
- "ClosingReasonId": {
3138
- "type": "object",
3139
- "properties": {
3140
- "id": {
3141
- "type": "string",
3142
- "example": "x739cew"
3143
- }
3144
- },
3145
- "required": [
3146
- "id"
3147
- ]
3148
- },
3149
- "ErrorResp": {
3150
- "type": "object",
3151
- "properties": {
3152
- "message": {
3153
- "type": "string"
3154
- }
3155
- }
3156
- },
3157
- "UpdateEntityAttributes": {
3158
- "type": "object",
3159
- "properties": {
3160
- "source": {
3161
- "type": "string",
3162
- "enum": [
3163
- "workflow_status",
3164
- "current_section",
3165
- "current_step"
3166
- ]
3167
- },
3168
- "target": {
3169
- "type": "object",
3170
- "properties": {
3171
- "entitySchema": {
3172
- "type": "string",
3173
- "example": "opportunity"
3174
- },
3175
- "entityAttribute": {
3176
- "type": "string",
3177
- "example": "my_status"
3178
- }
3179
- },
3180
- "required": [
3181
- "entitySchema",
3182
- "entityAttribute"
3183
- ]
3184
- }
3185
- },
3186
- "required": [
3187
- "source",
3188
- "target"
3189
- ]
3190
- },
3191
- "EntitySync": {
3192
- "type": "object",
3193
- "properties": {
3194
- "trigger": {
3195
- "type": "object",
3196
- "description": "Trigger configuration that determines when entity sync occurs.\nContains the event type and optional filter to target specific tasks/phases.\n",
3197
- "required": [
3198
- "event"
3199
- ],
3200
- "properties": {
3201
- "event": {
3202
- "type": "string",
3203
- "description": "Event or condition that triggers the entity sync.\nDirect triggers match EventBridge event names (PascalCase).\nStatus triggers are deduced from event + entity status combination.\n",
3204
- "enum": [
3205
- "FlowStarted",
3206
- "FlowCompleted",
3207
- "FlowCancelled",
3208
- "FlowReopened",
3209
- "FlowDeleted",
3210
- "FlowAssigned",
3211
- "FlowDueDateChanged",
3212
- "FlowContextsChanged",
3213
- "TaskUpdated",
3214
- "CurrTaskChanged",
3215
- "TaskCompleted",
3216
- "TaskSkipped",
3217
- "TaskMarkedInProgress",
3218
- "TaskMarkedOnHold",
3219
- "PhaseUpdated",
3220
- "PhaseCompleted",
3221
- "PhaseSkipped",
3222
- "PhaseMarkedInProgress"
3223
- ]
3224
- },
3225
- "filter": {
3226
- "type": "object",
3227
- "description": "Optional filter to target specific tasks or phases.\nSpecify either task_template_id OR phase_template_id (mutually exclusive).\nIf omitted, trigger applies to all tasks/phases.\n",
3228
- "properties": {
3229
- "task_template_id": {
3230
- "type": "string",
3231
- "description": "Target a specific task by its template ID (stable across executions)"
3232
- },
3233
- "phase_template_id": {
3234
- "type": "string",
3235
- "description": "Target a specific phase by its template ID (stable across executions)"
3236
- }
3237
- }
3238
- }
3239
- }
3240
- },
3241
- "value": {
3242
- "type": "object",
3243
- "properties": {
3244
- "source": {
3245
- "type": "string",
3246
- "enum": [
3247
- "workflow_name",
3248
- "workflow_status",
3249
- "workflow_assigned_to",
3250
- "task_name",
3251
- "task_status",
3252
- "task_assigned_to",
3253
- "phase_name",
3254
- "phase_status",
3255
- "phase_assigned_to",
3256
- "custom_value"
3257
- ]
3258
- },
3259
- "value": {
3260
- "type": "string"
3261
- }
3262
- },
3263
- "required": [
3264
- "source"
3265
- ]
3266
- },
3267
- "target": {
3268
- "type": "object",
3269
- "properties": {
3270
- "entitySchema": {
3271
- "type": "string",
3272
- "example": "opportunity"
3273
- },
3274
- "entityAttribute": {
3275
- "type": "string",
3276
- "example": "title"
3277
- }
3278
- },
3279
- "required": [
3280
- "entitySchema",
3281
- "entityAttribute"
3282
- ]
3283
- }
3284
- },
3285
- "example": {
3286
- "trigger": {
3287
- "event": "FlowStarted"
3288
- },
3289
- "target": {
3290
- "entitySchema": "opportunity",
3291
- "entityAttribute": "title"
3292
- },
3293
- "value": {
3294
- "source": "workflow_name"
3295
- }
3296
- },
3297
- "required": [
3298
- "trigger",
3299
- "target",
3300
- "value"
3301
- ]
3302
- },
3303
- "DynamicDueDate": {
3304
- "description": "set a Duedate for a step then a specific",
3305
- "type": "object",
3306
- "properties": {
3307
- "numberOfUnits": {
3308
- "type": "number"
3309
- },
3310
- "timePeriod": {
3311
- "$ref": "#/components/schemas/TimeUnit"
3312
- },
3313
- "actionTypeCondition": {
3314
- "type": "string",
3315
- "enum": [
3316
- "WORKFLOW_STARTED",
3317
- "STEP_CLOSED",
3318
- "PHASE_FINISHED"
3319
- ]
3320
- },
3321
- "stepId": {
3322
- "type": "string"
3323
- },
3324
- "phaseId": {
3325
- "type": "string"
3326
- }
3327
- },
3328
- "required": [
3329
- "numberOfUnits",
3330
- "timePeriod",
3331
- "actionTypeCondition"
3332
- ]
3333
- },
3334
- "StepRequirement": {
3335
- "description": "describe the requirement for step enablement",
3336
- "type": "object",
3337
- "properties": {
3338
- "definitionId": {
3339
- "type": "string"
3340
- },
3341
- "type": {
3342
- "$ref": "#/components/schemas/ItemType"
3343
- },
3344
- "condition": {
3345
- "type": "string",
3346
- "enum": [
3347
- "CLOSED"
3348
- ]
3349
- }
3350
- },
3351
- "required": [
3352
- "definitionId",
3353
- "type",
3354
- "condition"
3355
- ]
3356
- },
3357
- "FlowTemplateExport": {
3358
- "allOf": [
3359
- {
3360
- "$ref": "#/components/schemas/FlowTemplate"
3361
- },
3362
- {
3363
- "type": "object",
3364
- "properties": {
3365
- "_resolved_automations": {
3366
- "type": "object",
3367
- "description": "Map of automation_id to full AutomationFlow object. Null values indicate automations that could not be resolved.",
3368
- "additionalProperties": {
3369
- "type": "object"
3370
- }
3371
- }
3372
- }
3373
- }
3374
- ]
3375
- },
3376
- "FlowTemplateImportResult": {
3377
- "type": "object",
3378
- "properties": {
3379
- "flow": {
3380
- "$ref": "#/components/schemas/FlowTemplate"
3381
- },
3382
- "_id_mappings": {
3383
- "type": "object",
3384
- "description": "Maps old IDs to new IDs for cross-referencing by callers (e.g. blueprint service)",
3385
- "properties": {
3386
- "flow_id": {
3387
- "type": "object",
3388
- "properties": {
3389
- "old": {
3390
- "type": "string"
3391
- },
3392
- "new": {
3393
- "type": "string"
3394
- }
3395
- }
3396
- },
3397
- "task_ids": {
3398
- "type": "object",
3399
- "additionalProperties": {
3400
- "type": "string"
3401
- },
3402
- "description": "Map of old_task_id to new_task_id"
3403
- },
3404
- "automation_ids": {
3405
- "type": "object",
3406
- "additionalProperties": {
3407
- "type": "string"
3408
- },
3409
- "description": "Map of old_automation_id to new_automation_id"
3410
- }
3411
- }
3412
- }
3413
- }
3414
- }
3415
- }
3416
- }
3417
- }