{ "info": { "_postman_id": "84e5daa7-15a1-4113-b380-69256c883d92", "name": "Webex Admin Address Book Flow API", "description": "The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "lastUpdatedBy": "35240", "uid": "35240-84e5daa7-15a1-4113-b380-69256c883d92" }, "item": [ { "name": "flow-store", "item": [ { "name": "{orgId}", "item": [ { "name": "project", "item": [ { "name": "{projectId}", "item": [ { "name": "flows", "item": [ { "name": "{flowId}:export", "item": [ { "name": "Export a Flow or Subflow", "id": "67616ab2-aa30-453c-a3e3-c3f4aa308b29", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:export?version=latest", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows", "{{flowId}}:export" ], "query": [ { "description": "Version ID. Possible values are 'draft', 'latest' or version ID like '64b92c004ccd9f3d1c680709'. Defaulted to 'latest'.", "key": "version", "value": "latest" } ], "variable": [ { "id": "c36d7d9a-37f8-4cb5-8e77-e3b7ea9607a1", "key": "orgId", "value": "", "description": "(Required) Organization ID." }, { "id": "998b2e0d-23a8-4b07-a1d4-6126b8836200", "key": "projectId", "value": "", "description": "(Required) Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b." } ] }, "description": "Returns the exported flow/subflow in response.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]" }, "response": [ { "id": "456eb2e7-69cc-4057-b097-fb48898afde4", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:export?version=latest", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows", "{{flowId}}:export" ], "query": [ { "description": "Version ID. Possible values are 'draft', 'latest' or version ID like '64b92c004ccd9f3d1c680709'. Defaulted to 'latest'.", "key": "version", "value": "latest" } ], "variable": [ { "key": "orgId" }, { "key": "projectId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"comment\": \"\",\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"description\": \"\",\n \"diagram\": {\n \"properties\": {},\n \"widgets\": {\n \"irure_2b8\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n },\n \"aute_9ca\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n }\n }\n },\n \"eventFlows\": {\n \"eventsMap\": {\n \"ad_8\": {\n \"description\": \"\",\n \"diagram\": {\n \"properties\": {},\n \"widgets\": {\n \"in_f\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"name\": \"\",\n \"onEvents\": {\n \"nisi782\": \"\",\n \"nisi5\": \"\"\n },\n \"process\": {\n \"activities\": {\n \"nostrud_0\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n }\n },\n \"links\": [\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n },\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n }\n ]\n }\n },\n \"cillum23_\": {\n \"description\": \"\",\n \"diagram\": {\n \"properties\": {},\n \"widgets\": {\n \"nostrudc89\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n },\n \"adipisicing2cd\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n },\n \"officia_47\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"name\": \"\",\n \"onEvents\": {\n \"voluptate_735\": \"\",\n \"nostrud_e\": \"\"\n },\n \"process\": {\n \"activities\": {\n \"nostrudbd0\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n }\n },\n \"links\": [\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n },\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n }\n ]\n }\n }\n },\n \"properties\": {}\n },\n \"flowId\": \"\",\n \"flowType\": \"\",\n \"id\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\",\n \"name\": \"\",\n \"orgId\": \"\",\n \"persist\": \"\",\n \"process\": {\n \"activities\": {\n \"Duis8\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n }\n },\n \"links\": [\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n },\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n }\n ]\n },\n \"runtimeVariables\": [\n {\n \"activityName\": \"\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"isSecure\": \"\",\n \"name\": \"\",\n \"path\": \"\",\n \"source\": \"\",\n \"type\": \"\",\n \"uiVisible\": \"\"\n },\n {\n \"activityName\": \"\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"isSecure\": \"\",\n \"name\": \"\",\n \"path\": \"\",\n \"source\": \"\",\n \"type\": \"\",\n \"uiVisible\": \"\"\n }\n ],\n \"settings\": [\n {\n \"group\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"group\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"validating\": \"\",\n \"validationResults\": [\n {\n \"activityId\": \"\",\n \"activityLabel\": \"\",\n \"code\": \"\",\n \"docLink\": \"\",\n \"message\": \"\",\n \"severity\": \"\"\n },\n {\n \"activityId\": \"\",\n \"activityLabel\": \"\",\n \"code\": \"\",\n \"docLink\": \"\",\n \"message\": \"\",\n \"severity\": \"\"\n }\n ],\n \"variableOrders\": {\n \"cupidatatc\": [\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n },\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n }\n ]\n },\n \"variables\": [\n {\n \"description\": \"\",\n \"desktopLabel\": \"\",\n \"id\": \"\",\n \"isAgentEditable\": \"\",\n \"isCAD\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"name\": \"\",\n \"overwrite\": \"\",\n \"source\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"description\": \"\",\n \"desktopLabel\": \"\",\n \"id\": \"\",\n \"isAgentEditable\": \"\",\n \"isCAD\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"name\": \"\",\n \"overwrite\": \"\",\n \"source\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"version\": \"\"\n}", "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-456eb2e7-69cc-4057-b097-fb48898afde4" }, { "id": "516c39f1-42c4-4cff-b0c9-5d42142e9589", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:export?version=latest", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows", "{{flowId}}:export" ], "query": [ { "description": "Version ID. Possible values are 'draft', 'latest' or version ID like '64b92c004ccd9f3d1c680709'. Defaulted to 'latest'.", "key": "version", "value": "latest" } ], "variable": [ { "key": "orgId" }, { "key": "projectId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-516c39f1-42c4-4cff-b0c9-5d42142e9589" }, { "id": "572c3761-ff85-4e93-b523-ccd69ff6d290", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:export?version=latest", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows", "{{flowId}}:export" ], "query": [ { "description": "Version ID. Possible values are 'draft', 'latest' or version ID like '64b92c004ccd9f3d1c680709'. Defaulted to 'latest'.", "key": "version", "value": "latest" } ], "variable": [ { "key": "orgId" }, { "key": "projectId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-572c3761-ff85-4e93-b523-ccd69ff6d290" }, { "id": "99855f04-8cf0-4f07-8106-2c595f77e1ad", "name": "Not Found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:export?version=latest", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows", "{{flowId}}:export" ], "query": [ { "description": "Version ID. Possible values are 'draft', 'latest' or version ID like '64b92c004ccd9f3d1c680709'. Defaulted to 'latest'.", "key": "version", "value": "latest" } ], "variable": [ { "key": "orgId" }, { "key": "projectId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-99855f04-8cf0-4f07-8106-2c595f77e1ad" } ], "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-67616ab2-aa30-453c-a3e3-c3f4aa308b29" } ], "id": "6e9e001d-c806-473b-af44-cc58afdaa758", "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-6e9e001d-c806-473b-af44-cc58afdaa758" }, { "name": "{flowId}:publish", "item": [ { "name": "Publish a Flow or Subflow", "id": "cf16320f-67d4-465a-93f6-f01dfb028b03", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "ID for tracking.", "key": "TrackingId", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:publish", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows", "{{flowId}}:publish" ], "variable": [ { "id": "9f18d068-d6a2-46fa-8a9d-5029cac367fb", "key": "orgId", "value": "", "description": "(Required) Organization ID." }, { "id": "a56477d0-ba38-4395-862b-18d2875ef477", "key": "projectId", "value": "", "description": "(Required) Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b." } ] }, "description": "Returns the published flow in response.\n\nThe Publish API validates the basic structure of the flows. We recommend manually verifying the published flows before proceeding with live traffic.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]" }, "response": [ { "id": "847a5e95-e4c7-4ab1-9a3e-3797184d6523", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "ID for tracking.", "key": "TrackingId", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:publish", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows", "{{flowId}}:publish" ], "variable": [ { "key": "orgId" }, { "key": "projectId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"assignedRS\": [\n \"\",\n \"\"\n ],\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"draftVersion\": {\n \"comment\": \"\",\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"description\": \"\",\n \"diagram\": {\n \"properties\": {},\n \"widgets\": {\n \"consequat_aa3\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n }\n }\n },\n \"eventFlows\": {\n \"eventsMap\": {\n \"Duis__7\": {\n \"description\": \"\",\n \"diagram\": {\n \"properties\": {},\n \"widgets\": {\n \"veniam3_6\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"name\": \"\",\n \"onEvents\": {\n \"officia8a5\": \"\"\n },\n \"process\": {\n \"activities\": {\n \"incididunt_8\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n },\n \"aute18\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n },\n \"minim_16\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n },\n \"pariatur_c5a\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n }\n },\n \"links\": [\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n },\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n }\n ]\n }\n }\n },\n \"properties\": {}\n },\n \"flowId\": \"\",\n \"flowType\": \"\",\n \"id\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\",\n \"name\": \"\",\n \"orgId\": \"\",\n \"persist\": \"\",\n \"process\": {\n \"activities\": {\n \"consectetured6\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n }\n },\n \"links\": [\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n },\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n }\n ]\n },\n \"runtimeVariables\": [\n {\n \"activityName\": \"\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"isSecure\": \"\",\n \"name\": \"\",\n \"path\": \"\",\n \"source\": \"\",\n \"type\": \"\",\n \"uiVisible\": \"\"\n },\n {\n \"activityName\": \"\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"isSecure\": \"\",\n \"name\": \"\",\n \"path\": \"\",\n \"source\": \"\",\n \"type\": \"\",\n \"uiVisible\": \"\"\n }\n ],\n \"settings\": [\n {\n \"group\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"group\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"validating\": \"\",\n \"validationResults\": [\n {\n \"activityId\": \"\",\n \"activityLabel\": \"\",\n \"code\": \"\",\n \"docLink\": \"\",\n \"message\": \"\",\n \"severity\": \"\"\n },\n {\n \"activityId\": \"\",\n \"activityLabel\": \"\",\n \"code\": \"\",\n \"docLink\": \"\",\n \"message\": \"\",\n \"severity\": \"\"\n }\n ],\n \"variableOrders\": {\n \"laborum0d\": [\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n },\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n }\n ],\n \"ut_3\": [\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n },\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n }\n ],\n \"eu_490\": [\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n },\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n }\n ]\n },\n \"variables\": [\n {\n \"description\": \"\",\n \"desktopLabel\": \"\",\n \"id\": \"\",\n \"isAgentEditable\": \"\",\n \"isCAD\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"name\": \"\",\n \"overwrite\": \"\",\n \"source\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"description\": \"\",\n \"desktopLabel\": \"\",\n \"id\": \"\",\n \"isAgentEditable\": \"\",\n \"isCAD\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"name\": \"\",\n \"overwrite\": \"\",\n \"source\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"version\": \"\"\n },\n \"flowType\": \"\",\n \"flowVersions\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\",\n \"latestVersion\": {\n \"comment\": \"\",\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"description\": \"\",\n \"diagram\": {\n \"properties\": {},\n \"widgets\": {\n \"eu_f_0\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n },\n \"dolor_58\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n },\n \"anim_\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n }\n }\n },\n \"eventFlows\": {\n \"eventsMap\": {\n \"aute9d\": {\n \"description\": \"\",\n \"diagram\": {\n \"properties\": {},\n \"widgets\": {\n \"irure_fd\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n },\n \"sed9\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"name\": \"\",\n \"onEvents\": {\n \"in_a\": \"\",\n \"cillum_2d\": \"\"\n },\n \"process\": {\n \"activities\": {\n \"elit_69\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n },\n \"veniam_9_\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n },\n \"nostrud_c2\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n }\n },\n \"links\": [\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n },\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n }\n ]\n }\n },\n \"laborumf51\": {\n \"description\": \"\",\n \"diagram\": {\n \"properties\": {},\n \"widgets\": {\n \"non_1e3\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n },\n \"dolore0\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n },\n \"quisa9\": {\n \"id\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"widgetType\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"name\": \"\",\n \"onEvents\": {\n \"sint59\": \"\"\n },\n \"process\": {\n \"activities\": {\n \"aute_97\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n },\n \"qui_5f\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n }\n },\n \"links\": [\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n },\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n }\n ]\n }\n }\n },\n \"properties\": {}\n },\n \"flowId\": \"\",\n \"flowType\": \"\",\n \"id\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\",\n \"name\": \"\",\n \"orgId\": \"\",\n \"persist\": \"\",\n \"process\": {\n \"activities\": {\n \"in_83\": {\n \"group\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"properties\": {}\n }\n },\n \"links\": [\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n },\n {\n \"conditionExpr\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"sourceActivityId\": \"\",\n \"targetActivityId\": \"\"\n }\n ]\n },\n \"runtimeVariables\": [\n {\n \"activityName\": \"\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"isSecure\": \"\",\n \"name\": \"\",\n \"path\": \"\",\n \"source\": \"\",\n \"type\": \"\",\n \"uiVisible\": \"\"\n },\n {\n \"activityName\": \"\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"isSecure\": \"\",\n \"name\": \"\",\n \"path\": \"\",\n \"source\": \"\",\n \"type\": \"\",\n \"uiVisible\": \"\"\n }\n ],\n \"settings\": [\n {\n \"group\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"group\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"validating\": \"\",\n \"validationResults\": [\n {\n \"activityId\": \"\",\n \"activityLabel\": \"\",\n \"code\": \"\",\n \"docLink\": \"\",\n \"message\": \"\",\n \"severity\": \"\"\n },\n {\n \"activityId\": \"\",\n \"activityLabel\": \"\",\n \"code\": \"\",\n \"docLink\": \"\",\n \"message\": \"\",\n \"severity\": \"\"\n }\n ],\n \"variableOrders\": {\n \"enim32\": [\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n },\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n }\n ],\n \"ipsum78\": [\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n },\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n }\n ],\n \"ullamco_0\": [\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n },\n {\n \"name\": \"\",\n \"variableSeq\": \"\"\n }\n ]\n },\n \"variables\": [\n {\n \"description\": \"\",\n \"desktopLabel\": \"\",\n \"id\": \"\",\n \"isAgentEditable\": \"\",\n \"isCAD\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"name\": \"\",\n \"overwrite\": \"\",\n \"source\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"description\": \"\",\n \"desktopLabel\": \"\",\n \"id\": \"\",\n \"isAgentEditable\": \"\",\n \"isCAD\": \"\",\n \"isReportable\": \"\",\n \"isSecure\": \"\",\n \"name\": \"\",\n \"overwrite\": \"\",\n \"source\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"version\": \"\"\n },\n \"lockedAt\": \"\",\n \"lockedBy\": \"\",\n \"orgId\": \"\",\n \"preferences\": [\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n ],\n \"projectId\": \"\",\n \"status\": \"\",\n \"tagHistories\": {\n \"non9a\": [\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n },\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n }\n ],\n \"sint_229\": [\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n },\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n }\n ],\n \"consectetur5\": [\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n },\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n }\n ],\n \"ipsum_94a\": [\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n },\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n }\n ],\n \"esse1db\": [\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n },\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n }\n ]\n },\n \"tags\": [\n {\n \"default\": \"\",\n \"displayName\": \"\",\n \"flowVersionId\": \"\",\n \"id\": \"\",\n \"versionNumber\": \"\"\n },\n {\n \"default\": \"\",\n \"displayName\": \"\",\n \"flowVersionId\": \"\",\n \"id\": \"\",\n \"versionNumber\": \"\"\n }\n ],\n \"validating\": \"\",\n \"version\": \"\"\n}", "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-847a5e95-e4c7-4ab1-9a3e-3797184d6523" }, { "id": "67fbaaea-a9b3-4398-b1f0-be1a2a0bee2c", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "ID for tracking.", "key": "TrackingId", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:publish", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows", "{{flowId}}:publish" ], "variable": [ { "key": "orgId" }, { "key": "projectId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-67fbaaea-a9b3-4398-b1f0-be1a2a0bee2c" }, { "id": "8e2b3105-4a55-420e-b213-80bb874c447a", "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "description": "ID for tracking.", "key": "TrackingId", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:publish", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows", "{{flowId}}:publish" ], "variable": [ { "key": "orgId" }, { "key": "projectId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-8e2b3105-4a55-420e-b213-80bb874c447a" }, { "id": "5c40160d-c746-42d7-8897-79b444fdca87", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "ID for tracking.", "key": "TrackingId", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:publish", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows", "{{flowId}}:publish" ], "variable": [ { "key": "orgId" }, { "key": "projectId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-5c40160d-c746-42d7-8897-79b444fdca87" }, { "id": "b8f52e34-a392-49c3-851a-80e1275144fc", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "description": "ID for tracking.", "key": "TrackingId", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:publish", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows", "{{flowId}}:publish" ], "variable": [ { "key": "orgId" }, { "key": "projectId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-b8f52e34-a392-49c3-851a-80e1275144fc" }, { "id": "bf50984d-3a85-44e3-a01f-e79ce5609437", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "ID for tracking.", "key": "TrackingId", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:publish", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows", "{{flowId}}:publish" ], "variable": [ { "key": "orgId" }, { "key": "projectId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-bf50984d-3a85-44e3-a01f-e79ce5609437" }, { "id": "4f5bfd76-6033-4a2e-84ac-e7604ad258df", "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "ID for tracking.", "key": "TrackingId", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"comment\": \"\",\n \"tagIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/{{flowId}}:publish", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows", "{{flowId}}:publish" ], "variable": [ { "key": "orgId" }, { "key": "projectId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-4f5bfd76-6033-4a2e-84ac-e7604ad258df" } ], "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-cf16320f-67d4-465a-93f6-f01dfb028b03" } ], "id": "75c426c0-b024-405f-82cf-5fbb5d9493cb", "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-75c426c0-b024-405f-82cf-5fbb5d9493cb" }, { "name": "List Flows or Subflows", "id": "4d76f377-6fca-4107-bac0-678eaf0ced32", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows?flowType=FLOW&ids=&ids=&page=0&partialNameSearch=&size=10&includePagination=false", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows" ], "query": [ { "description": "Either of 'FLOW' or 'SUBFLOW'.", "key": "flowType", "value": "FLOW" }, { "description": "Filters results based on a comma-separated list of flow IDs. If provided, only flows with those IDs will be fetched in the response.", "key": "ids", "value": "" }, { "description": "Filters results based on a comma-separated list of flow IDs. If provided, only flows with those IDs will be fetched in the response.", "key": "ids", "value": "" }, { "description": "Defines the number of the displayed page. The page number starts from 0.", "key": "page", "value": "0" }, { "description": "Performs a partial string match on the name of the flow. If the flow name contains the given string it will be fetched in the response.", "key": "partialNameSearch", "value": "" }, { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "size", "value": "10" }, { "description": "If set to to true then a different paginated response object containing the page metadata (currentPage, totalRecords, pageSize, totalPages) will be returned. The flow objects will be in an array named \"data\".", "key": "includePagination", "value": "false" } ], "variable": [ { "id": "3fd6f975-cd2a-46aa-8861-c332b7dd0789", "key": "orgId", "value": "", "description": "(Required) Organization ID." }, { "id": "1ac2c317-2b85-40c1-9f08-cae7183682fe", "key": "projectId", "value": "", "description": "(Required) Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b." } ] }, "description": "Returns a list of flows in response.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]" }, "response": [ { "id": "e26dadf0-fabb-4b0e-b8a1-407cd4d06484", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows?flowType=FLOW&ids=&page=0&partialNameSearch=&size=10&includePagination=false", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows" ], "query": [ { "description": "Either of 'FLOW' or 'SUBFLOW'.", "key": "flowType", "value": "FLOW" }, { "description": "Filters results based on a comma-separated list of flow IDs. If provided, only flows with those IDs will be fetched in the response.", "key": "ids", "value": "" }, { "description": "Defines the number of the displayed page. The page number starts from 0.", "key": "page", "value": "0" }, { "description": "Performs a partial string match on the name of the flow. If the flow name contains the given string it will be fetched in the response.", "key": "partialNameSearch", "value": "" }, { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "size", "value": "10" }, { "description": "If set to to true then a different paginated response object containing the page metadata (currentPage, totalRecords, pageSize, totalPages) will be returned. The flow objects will be in an array named \"data\".", "key": "includePagination", "value": "false" } ], "variable": [ { "key": "orgId" }, { "key": "projectId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"assignedRS\": [\n \"\",\n \"\"\n ],\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"description\": \"\",\n \"flowType\": \"\",\n \"id\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\",\n \"lockedAt\": \"\",\n \"lockedBy\": \"\",\n \"name\": \"\",\n \"orgId\": \"\",\n \"status\": \"\",\n \"tagHistories\": {\n \"anima0\": [\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n },\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n }\n ]\n },\n \"tags\": [\n {\n \"default\": \"\",\n \"displayName\": \"\",\n \"flowVersionId\": \"\",\n \"id\": \"\",\n \"versionNumber\": \"\"\n },\n {\n \"default\": \"\",\n \"displayName\": \"\",\n \"flowVersionId\": \"\",\n \"id\": \"\",\n \"versionNumber\": \"\"\n }\n ],\n \"version\": \"\"\n },\n {\n \"assignedRS\": [\n \"\",\n \"\"\n ],\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"description\": \"\",\n \"flowType\": \"\",\n \"id\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\",\n \"lockedAt\": \"\",\n \"lockedBy\": \"\",\n \"name\": \"\",\n \"orgId\": \"\",\n \"status\": \"\",\n \"tagHistories\": {\n \"deserunt922\": [\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n },\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n }\n ],\n \"qui_46\": [\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n },\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n }\n ]\n },\n \"tags\": [\n {\n \"default\": \"\",\n \"displayName\": \"\",\n \"flowVersionId\": \"\",\n \"id\": \"\",\n \"versionNumber\": \"\"\n },\n {\n \"default\": \"\",\n \"displayName\": \"\",\n \"flowVersionId\": \"\",\n \"id\": \"\",\n \"versionNumber\": \"\"\n }\n ],\n \"version\": \"\"\n }\n]", "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-e26dadf0-fabb-4b0e-b8a1-407cd4d06484" }, { "id": "7168e1b0-ec52-446b-86a7-99ecb1c73ea9", "name": "Bad request", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows?flowType=FLOW&ids=&page=0&partialNameSearch=&size=10&includePagination=false", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows" ], "query": [ { "description": "Either of 'FLOW' or 'SUBFLOW'.", "key": "flowType", "value": "FLOW" }, { "description": "Filters results based on a comma-separated list of flow IDs. If provided, only flows with those IDs will be fetched in the response.", "key": "ids", "value": "" }, { "description": "Defines the number of the displayed page. The page number starts from 0.", "key": "page", "value": "0" }, { "description": "Performs a partial string match on the name of the flow. If the flow name contains the given string it will be fetched in the response.", "key": "partialNameSearch", "value": "" }, { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "size", "value": "10" }, { "description": "If set to to true then a different paginated response object containing the page metadata (currentPage, totalRecords, pageSize, totalPages) will be returned. The flow objects will be in an array named \"data\".", "key": "includePagination", "value": "false" } ], "variable": [ { "key": "orgId" }, { "key": "projectId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-7168e1b0-ec52-446b-86a7-99ecb1c73ea9" }, { "id": "7a0b9cd7-b437-4c1c-855a-f598b3bb4f18", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows?flowType=FLOW&ids=&page=0&partialNameSearch=&size=10&includePagination=false", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows" ], "query": [ { "description": "Either of 'FLOW' or 'SUBFLOW'.", "key": "flowType", "value": "FLOW" }, { "description": "Filters results based on a comma-separated list of flow IDs. If provided, only flows with those IDs will be fetched in the response.", "key": "ids", "value": "" }, { "description": "Defines the number of the displayed page. The page number starts from 0.", "key": "page", "value": "0" }, { "description": "Performs a partial string match on the name of the flow. If the flow name contains the given string it will be fetched in the response.", "key": "partialNameSearch", "value": "" }, { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "size", "value": "10" }, { "description": "If set to to true then a different paginated response object containing the page metadata (currentPage, totalRecords, pageSize, totalPages) will be returned. The flow objects will be in an array named \"data\".", "key": "includePagination", "value": "false" } ], "variable": [ { "key": "orgId" }, { "key": "projectId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-7a0b9cd7-b437-4c1c-855a-f598b3bb4f18" }, { "id": "4bb6ab3a-39fa-428c-9610-625b607a3ecd", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows?flowType=FLOW&ids=&page=0&partialNameSearch=&size=10&includePagination=false", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows" ], "query": [ { "description": "Either of 'FLOW' or 'SUBFLOW'.", "key": "flowType", "value": "FLOW" }, { "description": "Filters results based on a comma-separated list of flow IDs. If provided, only flows with those IDs will be fetched in the response.", "key": "ids", "value": "" }, { "description": "Defines the number of the displayed page. The page number starts from 0.", "key": "page", "value": "0" }, { "description": "Performs a partial string match on the name of the flow. If the flow name contains the given string it will be fetched in the response.", "key": "partialNameSearch", "value": "" }, { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "size", "value": "10" }, { "description": "If set to to true then a different paginated response object containing the page metadata (currentPage, totalRecords, pageSize, totalPages) will be returned. The flow objects will be in an array named \"data\".", "key": "includePagination", "value": "false" } ], "variable": [ { "key": "orgId" }, { "key": "projectId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-4bb6ab3a-39fa-428c-9610-625b607a3ecd" }, { "id": "bfd16e56-f43a-4d5b-bb41-1886b4e3caa2", "name": "Not Found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows?flowType=FLOW&ids=&page=0&partialNameSearch=&size=10&includePagination=false", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows" ], "query": [ { "description": "Either of 'FLOW' or 'SUBFLOW'.", "key": "flowType", "value": "FLOW" }, { "description": "Filters results based on a comma-separated list of flow IDs. If provided, only flows with those IDs will be fetched in the response.", "key": "ids", "value": "" }, { "description": "Defines the number of the displayed page. The page number starts from 0.", "key": "page", "value": "0" }, { "description": "Performs a partial string match on the name of the flow. If the flow name contains the given string it will be fetched in the response.", "key": "partialNameSearch", "value": "" }, { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "size", "value": "10" }, { "description": "If set to to true then a different paginated response object containing the page metadata (currentPage, totalRecords, pageSize, totalPages) will be returned. The flow objects will be in an array named \"data\".", "key": "includePagination", "value": "false" } ], "variable": [ { "key": "orgId" }, { "key": "projectId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-bfd16e56-f43a-4d5b-bb41-1886b4e3caa2" }, { "id": "aee66d3d-77b6-4c99-b04e-d3700e955921", "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows?flowType=FLOW&ids=&page=0&partialNameSearch=&size=10&includePagination=false", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows" ], "query": [ { "description": "Either of 'FLOW' or 'SUBFLOW'.", "key": "flowType", "value": "FLOW" }, { "description": "Filters results based on a comma-separated list of flow IDs. If provided, only flows with those IDs will be fetched in the response.", "key": "ids", "value": "" }, { "description": "Defines the number of the displayed page. The page number starts from 0.", "key": "page", "value": "0" }, { "description": "Performs a partial string match on the name of the flow. If the flow name contains the given string it will be fetched in the response.", "key": "partialNameSearch", "value": "" }, { "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.", "key": "size", "value": "10" }, { "description": "If set to to true then a different paginated response object containing the page metadata (currentPage, totalRecords, pageSize, totalPages) will be returned. The flow objects will be in an array named \"data\".", "key": "includePagination", "value": "false" } ], "variable": [ { "key": "orgId" }, { "key": "projectId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-aee66d3d-77b6-4c99-b04e-d3700e955921" } ], "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-4d76f377-6fca-4107-bac0-678eaf0ced32" } ], "id": "a884ea79-722a-484a-8fc6-ab787fd61778", "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-a884ea79-722a-484a-8fc6-ab787fd61778" }, { "name": "flows:import", "item": [ { "name": "Import a Flow or Subflow", "id": "1f23f29a-ceea-45d3-b146-48575bd04a0e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) Content length value in number of bytes.", "key": "Content-Length", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) Upload a file containing a `FlowVersionRes` object.", "key": "file", "type": "file", "value": null } ] }, "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import?overwrite=&flowType=", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows:import" ], "query": [ { "description": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.", "key": "overwrite", "value": "" }, { "description": "Either of 'FLOW' or 'SUBFLOW'.", "key": "flowType", "value": "" } ], "variable": [ { "id": "35e43a19-e578-4c58-9f64-1782f43526ed", "key": "orgId", "value": "", "description": "(Required) Organization ID." }, { "id": "bbfb6fc3-5805-4342-a340-7ee3898744ab", "key": "projectId", "value": "", "description": "(Required) Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b." } ] }, "description": "Returns the imported flow/subflow in response.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]" }, "response": [ { "id": "c8aedd28-08f6-4e4e-865a-191283962ae9", "name": "CREATED: Flow or Subflow is created.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Content length value in number of bytes.", "key": "Content-Length", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) Upload a file containing a `FlowVersionRes` object.", "key": "file", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import?overwrite=&flowType=", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows:import" ], "query": [ { "description": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.", "key": "overwrite", "value": "" }, { "description": "Either of 'FLOW' or 'SUBFLOW'.", "key": "flowType", "value": "" } ], "variable": [ { "key": "orgId" }, { "key": "projectId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"assignedRS\": [\n \"\",\n \"\"\n ],\n \"createdBy\": \"\",\n \"createdDate\": \"\",\n \"description\": \"\",\n \"flowType\": \"\",\n \"id\": \"\",\n \"lastModifiedBy\": \"\",\n \"lastModifiedDate\": \"\",\n \"lockedAt\": \"\",\n \"lockedBy\": \"\",\n \"name\": \"\",\n \"orgId\": \"\",\n \"status\": \"\",\n \"tagHistories\": {\n \"utf6\": [\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n },\n {\n \"forkFrom\": \"\",\n \"fvId\": \"\",\n \"fvName\": \"\"\n }\n ]\n },\n \"tags\": [\n {\n \"default\": \"\",\n \"displayName\": \"\",\n \"flowVersionId\": \"\",\n \"id\": \"\",\n \"versionNumber\": \"\"\n },\n {\n \"default\": \"\",\n \"displayName\": \"\",\n \"flowVersionId\": \"\",\n \"id\": \"\",\n \"versionNumber\": \"\"\n }\n ],\n \"version\": \"\"\n}", "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-c8aedd28-08f6-4e4e-865a-191283962ae9" }, { "id": "df3b55e1-9b47-43ab-9223-577488254e0c", "name": "BAD REQUEST: Possible causes - Import file size exceeded the limit. File parse error. Flow name is empty. Invalid flow type. Invalid activity.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Content length value in number of bytes.", "key": "Content-Length", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) Upload a file containing a `FlowVersionRes` object.", "key": "file", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import?overwrite=&flowType=", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows:import" ], "query": [ { "description": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.", "key": "overwrite", "value": "" }, { "description": "Either of 'FLOW' or 'SUBFLOW'.", "key": "flowType", "value": "" } ], "variable": [ { "key": "orgId" }, { "key": "projectId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-df3b55e1-9b47-43ab-9223-577488254e0c" }, { "id": "10ef327c-bfe3-4507-a19d-0f7d2cc3943a", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Content length value in number of bytes.", "key": "Content-Length", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) Upload a file containing a `FlowVersionRes` object.", "key": "file", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import?overwrite=&flowType=", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows:import" ], "query": [ { "description": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.", "key": "overwrite", "value": "" }, { "description": "Either of 'FLOW' or 'SUBFLOW'.", "key": "flowType", "value": "" } ], "variable": [ { "key": "orgId" }, { "key": "projectId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-10ef327c-bfe3-4507-a19d-0f7d2cc3943a" }, { "id": "bca8f409-fb4f-4674-a2a9-a502c6e4595c", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Content length value in number of bytes.", "key": "Content-Length", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) Upload a file containing a `FlowVersionRes` object.", "key": "file", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import?overwrite=&flowType=", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows:import" ], "query": [ { "description": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.", "key": "overwrite", "value": "" }, { "description": "Either of 'FLOW' or 'SUBFLOW'.", "key": "flowType", "value": "" } ], "variable": [ { "key": "orgId" }, { "key": "projectId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-bca8f409-fb4f-4674-a2a9-a502c6e4595c" }, { "id": "6cf52f7f-7fa7-4b29-b389-6f50838fa85e", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Content length value in number of bytes.", "key": "Content-Length", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) Upload a file containing a `FlowVersionRes` object.", "key": "file", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import?overwrite=&flowType=", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows:import" ], "query": [ { "description": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.", "key": "overwrite", "value": "" }, { "description": "Either of 'FLOW' or 'SUBFLOW'.", "key": "flowType", "value": "" } ], "variable": [ { "key": "orgId" }, { "key": "projectId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-6cf52f7f-7fa7-4b29-b389-6f50838fa85e" }, { "id": "31b2e90e-c315-4323-ad2c-88a84c5785f9", "name": "CONFLICT: A flow/subflow with the same name already exists.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Content length value in number of bytes.", "key": "Content-Length", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) Upload a file containing a `FlowVersionRes` object.", "key": "file", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import?overwrite=&flowType=", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows:import" ], "query": [ { "description": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.", "key": "overwrite", "value": "" }, { "description": "Either of 'FLOW' or 'SUBFLOW'.", "key": "flowType", "value": "" } ], "variable": [ { "key": "orgId" }, { "key": "projectId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-31b2e90e-c315-4323-ad2c-88a84c5785f9" }, { "id": "7f4b811b-fc79-4f7f-ab1b-0f21fb282c21", "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Content length value in number of bytes.", "key": "Content-Length", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) Upload a file containing a `FlowVersionRes` object.", "key": "file", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import?overwrite=&flowType=", "host": [ "{{baseUrl}}" ], "path": [ "flow-store", ":orgId", "project", ":projectId", "flows:import" ], "query": [ { "description": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.", "key": "overwrite", "value": "" }, { "description": "Either of 'FLOW' or 'SUBFLOW'.", "key": "flowType", "value": "" } ], "variable": [ { "key": "orgId" }, { "key": "projectId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-7f4b811b-fc79-4f7f-ab1b-0f21fb282c21" } ], "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-1f23f29a-ceea-45d3-b146-48575bd04a0e" } ], "id": "00f4bc9a-b516-41d8-a253-dd9e43deeab3", "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-00f4bc9a-b516-41d8-a253-dd9e43deeab3" } ], "id": "b7598fdd-9a30-4dd1-891a-bbee770a791d", "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-b7598fdd-9a30-4dd1-891a-bbee770a791d" } ], "id": "cc5e46ec-4bd5-4aea-8a57-d18194778e71", "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-cc5e46ec-4bd5-4aea-8a57-d18194778e71" } ], "id": "ad1c19ac-43f8-4fe7-a621-2a41c9898660", "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-ad1c19ac-43f8-4fe7-a621-2a41c9898660" } ], "id": "758e2d18-3cb2-4749-a7b1-2fcfd5c36df8", "createdAt": "2026-07-28T11:10:48.000Z", "updatedAt": "2026-07-28T11:10:48.000Z", "uid": "35240-758e2d18-3cb2-4749-a7b1-2fcfd5c36df8" } ], "variable": [ { "key": "baseUrl", "value": "/" }, { "key": "flowId", "value": "" } ] }